alias_api.AlCameraNode

class alias_api.AlCameraNode

Bases: AlDagNode

Dag node class for cameras.

This class is a dag node class used specifically for cameras. Each AlCamera object has three camera nodes. One for each of eye, view and up positions. (For more information on how AlCamera’s and AlCameraNode’s work together, see the Class Description for the AlCamera object.)

To create a camera node, the user must create a camera, which will automatically create the necessary camera nodes. The user cannot directly instantiate an AlCameraNode.

To figure out which position a camera node represents, the user can use:

  1. the is_eye_node(), is_view_node(), is_up_node() methods, or

2) the type() method to compare types with CameraEyeType, CameraUpType, or CameraViewType.

A camera node can be deleted in two ways. When a camera node is deleted, its associated camera (and other camera nodes) are deleted. When a camera is deleted, its camera nodes are also deleted.

camera(*args, **kwargs)

Overloaded function.

  1. camera(self: alias_api.AlCameraNode) -> alias_api.AlCamera

    Return the attached AlCamera object.

    return

    The attached AlCamera object.

    rtype

    AlCamera

  2. camera(self: alias_api.AlCameraNode, arg0: alias_api.AlTM) -> alias_api.AlCamera

    Return the attached AlCamera object.

    The AlTM will be updated with the camera node’s transformation amtrix, if a camera exists.

    param tm

    The transform matrix.

    type tm

    AlTM

    return

    The attached AlCamera object.

    rtype

    AlCamera

copy_wrapper(self: alias_api.AlCameraNode) → alias_api.AlObject

Return an exact duplicate of this AlCameraNode wrapper.

delete_object(self: alias_api.AlCameraNode) → int

Delete the AlCameraNode from the Alias Universe and return the status of the performed operation.

is_eye_node(self: alias_api.AlCameraNode) → int

Return True if this camera node represents the eye position of a camera.

is_instanceable(self: alias_api.AlCameraNode) → int

Return False. An AlCameraNode is not an instanceable dag node.

is_up_node(self: alias_api.AlCameraNode) → int

Return True if this camera node represents the up position of a camera.

is_view_node(self: alias_api.AlCameraNode) → int

Return True if this camera node represents the view position of a camera.

type(self: alias_api.AlCameraNode) → alias_api.AlObjectType

Return the AlCameraNode type identifier.