xsi_scene.h
Go to the documentation of this file.
00001 //*****************************************************************************
00011 //*****************************************************************************
00012 
00013 #if (_MSC_VER > 1000) || defined(SGI_COMPILER)
00014 #pragma once
00015 #endif
00016 
00017 #ifndef __XSISCENE_H__
00018 #define __XSISCENE_H__
00019 
00020 #include <xsi_projectitem.h>
00021 
00022 namespace XSI {
00023 
00024 class Model;
00025 class Property;
00026 class Layer;
00027 class Pass;
00028 class Library;
00029 class SimulationEnvironment;
00030 class FileReference;
00031 class PassContainer;
00032 class ImageClip2;
00033 
00034 //*****************************************************************************
00093 //*****************************************************************************
00094 
00095 class SICPPSDKDECL Scene : public ProjectItem
00096 {
00097 public:
00099     Scene();
00100 
00102     ~Scene();
00103 
00107     Scene(const CRef& in_ref);
00108 
00112     Scene(const Scene& in_obj);
00113 
00118     bool IsA( siClassID in_ClassID) const;
00119 
00123     siClassID GetClassID() const;
00124 
00130     Scene& operator=(const Scene& in_obj);
00131 
00137     Scene& operator=(const CRef& in_ref);
00138 
00151     Model       GetRoot() const;
00152 
00163     Property    GetColors() const;
00164 
00172     Layer       GetActiveLayer() const;
00173 
00182     Pass        GetActivePass() const;
00183 
00189     CRefArray   GetLayers() const;
00190 
00196     CRefArray   GetPasses() const;
00197 
00205     PassContainer   GetPassContainer() const;
00206 
00215     Library     GetActiveMaterialLibrary() const;
00216 
00223     CRefArray   GetMaterialLibraries() const;
00224 
00233     SimulationEnvironment   GetActiveSimulationEnvironment() const;
00234 
00241     CRefArray   GetSimulationEnvironments() const;
00242 
00247     CRefArray   GetProperties() const;
00248 
00255     CRefArray GetExternalFiles() const;
00256 
00267     FileReference GetExternalFileFromGUID(const CString &in_csGUID)const;
00268 
00281     CRefArray GetImageClips() const;
00282 
00288     ImageClip2 GetDefaultImageClip();
00289 
00296     CRefArray GetRenderableCameras() const;
00297 
00302     CRefArray GetAllCacheClipsAndObjects( CString& out_csObjectNames ) const;
00303 
00304     private:
00305     Scene * operator&() const;
00306     Scene * operator&();
00307 };
00308 
00309 };
00310 
00311 #endif // __XSISCENE_H__