Package autodesk_toxik :: Module precompmodule :: Class RenderCamera

Class RenderCamera

   object --+    
            |    
PrecompObject --+
                |
               RenderCamera

Class representing a render camera.

Instance Methods

__init__(self, camera, scene, partOfACameraSet=False)
Constructor from a precomp module RenderCamera instance and a Scene instance.

bool

isPartOfACameraSet(self)
Returns: True if this RenderCamera is part of a camera set.

Scene

getScene(self)
Returns: The Scene instance this RenderCamera belongs to.

str

getName(self)
Returns: The camera display name, as a unicode string.

str

getAnchor(self)
Returns: The camera anchor, as a unicode string.

int

getVersion(self)
Returns: The version number of the camera, as an integer.

str

getDescription(self)
Returns: The camera description, possibly empty, as a unicode string.

str

getNote(self)
Returns: A note about the camera, possibly empty, as a unicode string.

str

getTemplateFilePath(self)
Returns: The absolute path (in unicode) to a ".txcomposition" file to use as a template to create the camera comp, or None.

bool

isSelectedForImport(self)
Returns: A bool indicating whether this camera should be imported by default.

[RenderLayer]

getRenderLayers(self)
Returns: A list of layers which are rendered through this camera, as RenderLayer instances.

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, camera, scene, partOfACameraSet=False)
(Constructor)

Constructor from a precomp module RenderCamera instance and a Scene instance.

Parameters:

camera (RenderCamera)
scene (Scene)
partOfACameraSet (bool)

Overrides: object.__init__

isPartOfACameraSet(self)

Returns: bool: True if this RenderCamera is part of a camera set.

getScene(self)

Returns: Scene: The Scene instance this RenderCamera belongs to.

getName(self)

Returns: str: The camera display name, as a unicode string. The camera name should be unique within the scene.

getAnchor(self)

Returns: str: The camera anchor, as a unicode string. The camera anchor should be unique within the scene.

getVersion(self)

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

getDescription(self)

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

getNote(self)

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

getTemplateFilePath(self)

Returns: str: The absolute path (in unicode) to a ".txcomposition" file to use as a template to create the camera comp, or None. Note that cameras that belong to a camera set should provide the same template.

isSelectedForImport(self)

Returns: bool: A bool indicating whether this camera should be imported by default.

getRenderLayers(self)

Returns: [RenderLayer]: A list of layers which are rendered through this camera, as RenderLayer instances.

Class RenderCamera

__init__(self, camera, scene, partOfACameraSet=False) (Constructor)

isPartOfACameraSet(self)

getScene(self)

getName(self)

getAnchor(self)

getVersion(self)

getDescription(self)

getNote(self)

getTemplateFilePath(self)

isSelectedForImport(self)

getRenderLayers(self)

init(self, camera, scene, partOfACameraSet=False)
(Constructor)