alias_api.AlLightNode

class alias_api.AlLightNode

Bases: AlDagNode

The dag node class for lights.

This class is a dag node class used specifically for lights. Each AlLight object has three light nodes for position, ‘look at’ and ‘up’ points. (For more information on how AlLight’s and AlLightNode’s work together, see the Class Description for the AlLight object.)

To create a light node, the user must create a specific type of light, which automatically creates the necessary light nodes. These light nodes are grouped and inserted into the universe’s dag. The user cannot directly instantiate a light node.

To figure out whether or not a light node represents a position, a ‘look at’ or an ‘up’ point, the user can use:

  1. the is_position_node(), is_look_at_node(), is_up_node() methods, or

  2. the type() method of the attached AlLight object.

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

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

Return an exact duplicate of this AlLightNode wrapper.

delete_object(self: alias_api.AlLightNode) → int

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

is_instanceable(self: alias_api.AlLightNode) → int

Return False. A light node can not be instanced.

is_look_at_node(self: alias_api.AlLightNode) → int

Return True if this node is a ‘look at’ node.

is_position_node(self: alias_api.AlLightNode) → int

Return True if this node is a ‘position’ node.

is_up_node(self: alias_api.AlLightNode) → int

Return True if this node is a ‘up’ node.

light(*args, **kwargs)

Overloaded function.

  1. light(self: alias_api.AlLightNode) -> alias_api.AlLight

Return the attached light object. If the light does not exist or is not the right type, None is returned.

  1. light(self: alias_api.AlLightNode, tm: alias_api.AlTM) -> alias_api.AlLight

    Return the attached light object.

    If the light does not exist or is not the right type, None is returned. The AlTM ‘tm’ will be updated with the light node’s transformation matrix, if a light exists.

    param tm

    The transform matrix to set the light node’s TM to.

    type tm

    AlTM

    return

    The attached light object.

    rtype

    AlLight

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

Return the AlLightNode type identifier.