Package autodesk_toxik :: Module precompmodule :: Class Scene
[frames] | no frames]

Class Scene

   object --+    
            |    
PrecompObject --+
                |
               Scene

Class representing a 3D scene.

Instance Methods
 
__init__(self, scene, precompModule)
Constructor from a precomp module Scene instance and a PrecompModule.
str
getName(self)
Returns: The name of the scene, as a unicode string.
str
getAnchor(self)
Returns: The scene anchor, as a unicode string.
 
getVersion(self)
Returns: The version number of the scene, as an integer.
str
getDescription(self)
Returns: The scene description, possibly empty, as a unicode string.
str
getNote(self)
Returns: A note about the scene, possibly empty, as a unicode string.
int
getRenderWidth(self)
Returns: The default render resolution width used in the scene, as an integer.
int
getRenderHeight(self)
Returns: The default render resolution height used in the scene, as an integer.
float
getRenderPixelRatio(self)
Returns: The default render pixel aspect ratio used in the scene, as a float.
int
getRenderNbChannels(self)
Returns: The default number of render channels used in the scene, as an integer.
int
getRenderDepth(self)
Returns: The default render bit depth used in the scene, as an integer.
float
getRate(self)
Returns: The rate of the scene (time units), as a float.
str
getRenderDirectory(self)
Returns: The root directory under which all render pass image files are produced, as an absolute unicode path.
[RenderCamera]
getRenderCameras(self)
Returns: The list of "renderable" cameras in the scene.

Inherited from PrecompObject: getAppId, getPrecompModule, invokePrecompMethod

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

Inherited from object: __class__

Method Details

__init__(self, scene, precompModule)
(Constructor)

 

Constructor from a precomp module Scene instance and a PrecompModule.

Parameters:
Overrides: object.__init__

getName(self)

 
Returns: str
The name of the scene, as a unicode string.

getAnchor(self)

 
Returns: str
The scene anchor, as a unicode string.

getVersion(self)

 
Returns:
The version number of the scene, as an integer.

getDescription(self)

 
Returns: str
The scene description, possibly empty, as a unicode string.

getNote(self)

 
Returns: str
A note about the scene, possibly empty, as a unicode string.

getRenderWidth(self)

 
Returns: int
The default render resolution width used in the scene, as an integer.

getRenderHeight(self)

 
Returns: int
The default render resolution height used in the scene, as an integer.

getRenderPixelRatio(self)

 
Returns: float
The default render pixel aspect ratio used in the scene, as a float.

getRenderNbChannels(self)

 
Returns: int
The default number of render channels used in the scene, as an integer. Supported number of channels are 1, 3 and 4.

getRenderDepth(self)

 
Returns: int
The default render bit depth used in the scene, as an integer. Supported depth values are 8, 16 and 32.

getRate(self)

 
Returns: float
The rate of the scene (time units), as a float.

getRenderDirectory(self)

 
Returns: str
The root directory under which all render pass image files are produced, as an absolute unicode path. Render pass image files are typically classified within subdirectories under that render directory.

getRenderCameras(self)

 
Returns: [RenderCamera]
The list of "renderable" cameras in the scene. Each item in the list is a list of RenderCamera instances. A camera list of cardinality greater than two represents a camera set (2 to N) (for example, right and left cameras of a stereoscopic view).