Classes 

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlLocator) → alias_api.AlObject: Return an exact duplicate of this AlLocator wrapper.

delete_object(self: alias_api.AlLocator) → int: Delete the AlLocator from the Alias Universe and return the status of the performed operation.

property invisible: Get or set the AlLocator invisibility property.

is_picked(self: alias_api.AlLocator) → int: On successfully checking the locator, return 1 if the AlLocator is picked, else return 0. On failure to check, return -1.

property layer: Get or set the AlLocator layer object property.

property name: Get or set the AlLocator name property.

pick(self: alias_api.AlLocator) → int: Pick the locator. This function has not effect if the locator is already picked.

templated(self: alias_api.AlLocator) → int: On successfully checking the locator, return 1 if the AlLocator depends on anoather object which is templated, else return 0. On failure to check, return -1.

type(self: alias_api.AlLocator) → alias_api.AlObjectType: Return the AlLocator type identifier.

unpick(self: alias_api.AlLocator) → int: Unpick the locator. This function has not effect if the locator is already picked.

AlCamera

class alias_api.AlCamera

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlCamera) → alias_api.AlObject: Return an exact duplicate of this AlCamera wrapper.

delete_object(self: alias_api.AlCamera) → int: Delete the AlCamera from the Alias Universe and return the status of the performed operation.

property name: Get or set the AlCamera name.

type(self: alias_api.AlCamera) → alias_api.AlObjectType: Return the AlCamera type identifier.

AlCameraNode

class alias_api.AlCameraNode

add_joint(self: alias_api.AlDagNode) → int: Add an AlJoint to this dag node to maintain IK information.

add_sibling_node(self: alias_api.AlDagNode, sibling: alias_api.AlDagNode) → int: Insert an AlDagNode as the next sibling of this AlDagNode object.

affected_transformation_matrix(*args, **kwargs)

Overloaded function.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM, matrix: alias_api.AlTM) -> int

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM) -> Tuple[int, List[List[float[4]][4]]]

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

bounding_box(self: alias_api.AlDagNode) → Tuple[int, List[List[float[4]][8]]]: Returns the eight corners of the bounding box in world space.

camera(*args, **kwargs)

Overloaded function.

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

Return the attached AlCamera object.

return

The attached AlCamera object.

rtype

AlCamera
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

comment(self: alias_api.AlDagNode) → Tuple[int, int, str]: Obtain the size and address of a block of textual data associated with the object.

copy_object(*args, **kwargs)

Overloaded function.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions = None) -> alias_api.AlDagNode

Copy this AlDagNode returning a pointer to the new copy.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions, num_of_blind_data_ids_to_copy: int, blind_data_ids_to_copy: int) -> alias_api.AlDagNode

Return an exact duplicate of this AlDagNode wrapper.

copy_transform(self: alias_api.AlDagNode, node: alias_api.AlDagNode) → int: Copy the local transformation from the given node on to this node.

copy_wrapper(self: alias_api.AlCameraNode) → alias_api.AlObject: Return an exact duplicate of this AlCameraNode wrapper.

create_symmetric_geometry(self: alias_api.AlDagNode) → int: Create the symmetric geometry for this node if it is on a symmetric plane.

delete_object(self: alias_api.AlCameraNode) → int: Delete the AlCameraNode from the Alias Universe and return the status of the performed operation.

do_updates(self: alias_api.AlDagNode, new_state: int = 1) → int: The doUpdate flag is used to notify the system that you are finished performing. If this flag is True, then it is equivalent to sending out a ‘geometry modified’ message to the rest of the system.

get_surface_orientation(self: alias_api.AlDagNode) → Tuple[int, int]: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

global_transformation_matrix(*args, **kwargs)

Overloaded function.

global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the global transformation matrix for the object.

global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the global transformation matrix for the object.

inverse_global_transformation_matrix(*args, **kwargs)

Overloaded function.

inverse_global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the inverse global transformation matrix for the object.

inverse_global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the inverse global transformation matrix for the object.

is_a_construction_plane(self: alias_api.AlDagNode) → int: Return True if the dag node is a construction plane.

is_ancestor_an_instance(self: alias_api.AlDagNode) → int: Returns True if this AlDagNode or one of its ancestors is an instance node, else False.

is_display_mode_set(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType) → int: Return true if the specified display mode is set (on), else false.

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_instanced(self: alias_api.AlDagNode) → int: Return True if this is an instance node.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

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.

layer(self: alias_api.AlDagNode) → alias_api.AlLayer: Returns layer the node is assigned.

local_rotate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node rotation based on the setting of the local axes.

local_rotation_angles(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: These angles allow you to determine how the local rotation axis have been rotated from their initial position.

local_rotation_axes(self: alias_api.AlDagNode) → Tuple[int, List[float[3]], List[float[3]], List[float[3]]]: Return the vectors representing the local rotation axes for this node. These axes are the three axes vectors in the world space co-ordinates.

local_transformation_matrix(*args, **kwargs)

Overloaded function.

local_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the local transformation matrix for the object.

local_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the local transformation matrix for the object.

local_translate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node translation based on the setting of the local axes.

property name: Get or set the AlDagNode name.

next_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s next sibling AlDagNode or None if there is no next sibling.

parent_node(self: alias_api.AlDagNode) → AlGroupNode: Returns the parent group node.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s previous sibling AlDagNode or None if there is no next sibling.

remove_blind_data(self: alias_api.AlDagNode, user_type: int) → int: Remove the block of data of the given type from the object.

remove_comment(self: alias_api.AlDagNode) → int: Remove the block of text associated with this object from the object itself.

remove_joint(self: alias_api.AlDagNode) → int: Remove the AlJoint to this dag node to maintain IK information.

rotate_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the rotation pivot position in world space.

rotation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of rotation (in degrees) about the x, y, and z axes.

scale(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of scale in the x, y, and z direction.

scale_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the scale pivot position in world space.

search_across(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search across the DAG tree (starting at the current node), for a dag node with a specific ‘name’.

search_below(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search the DAG tree (rooted at the child of the current node), for a dag node with a specific ‘name’.

send_geometry_modified_message(self: alias_api.AlDagNode) → int: Send out an update message notifying that the geometry of this dag node has been modified.

set_blind_data(self: alias_api.AlDagNode, user_type: int, size: int, data: str) → int: Associates a block of ‘data’ with the object.

set_comment(self: alias_api.AlDagNode, size: int, data: str) → int: Associates a block of textual ‘data’ with the object.

set_display_mode(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType, on: int) → int: Set the display mode (by name) for this dag node.

set_layer(*args, **kwargs)

Overloaded function.

set_layer(self: alias_api.AlDagNode, layer: alias_api.AlLayer) -> int
Set the layer on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer

The layer object to be assigned to the AlDagNode

type layer

AlLayer

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)
set_layer(self: alias_api.AlDagNode, layer_number: int) -> int
Set the layer ID on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer_number

The layer number to be assigned to the AlDagNode

type layer_number

int

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer number is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)

set_local_rotation_angles(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Setting the local rotation angles is the only means by which the local rotations axes can be modified.

set_local_rotation_axes(self: alias_api.AlDagNode, arg0: List[float[3]], arg1: List[float[3]], arg2: List[float[3]]) → int: Set the local rotation axes of this dag node to the given world space vectors.

set_rotate_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the rotate pivot and return the status code result of the operation.

set_rotation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the amount of rotation (in degress) about the x, y, z axes. The rotation will be done after the scale transformation and before the final local translation.

set_scale(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the local scale vector. The scale transformation will be done before the local rotations. There is no restriction on the values of the components of the scale vector.

set_scale_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the scale pivot and return the status code result of the operation.

set_surface_orientation(self: alias_api.AlDagNode, flag: int) → int: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

set_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final local translation vector. The translation transformation will be done after rotations.

set_world_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final world translation vector.

translation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the final local translation vector.

type(self: alias_api.AlCameraNode) → alias_api.AlObjectType: Return the AlCameraNode type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

update_draw_info(self: alias_api.AlDagNode) → int: Force the internal draw information to be updated to match the dag node’s geometry.

version(self: alias_api.AlDagNode) → int: Return the version of the dag node.

AlCluster

class alias_api.AlCluster

apply_iterator_to_members(self: alias_api.AlCluster, iterator: AlIterator, return_code: int) → int: Apply the given iterator to each member o this cluster.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

cluster_node(self: alias_api.AlCluster) → AlClusterNode: Return a pointer to the attached (parent) cluster node. The cluster node must exist.

copy_wrapper(self: alias_api.AlCluster) → alias_api.AlObject: Return an exact duplicate of this AlCluster wrapper.

create(self: alias_api.AlCluster) → int: Create a cluster and a cluster dag node. The cluster dag node is automatically added to the current universe.

delete_object(self: alias_api.AlCluster) → int: Delete the AlCluster from the Alias Universe and return the status of the performed operation.

is_empty(self: alias_api.AlCluster) → int: Return True if this cluster is empty (does not have any memebrs).

property name: Get or set the object name.

next_cluster(self: alias_api.AlCluster) → alias_api.AlCluster: Return a pointer to the cluster following this onei n the global cluster list.

number_of_members(self: alias_api.AlCluster) → int: Return the number of members in this cluster.

prev_cluster(self: alias_api.AlCluster) → alias_api.AlCluster: Return a pointer to the cluster preceding this onei n the global cluster list.

type(self: alias_api.AlCluster) → alias_api.AlObjectType: Return the AlCluster type identifier.

AlClusterNode

class alias_api.AlClusterNode

add_joint(self: alias_api.AlDagNode) → int: Add an AlJoint to this dag node to maintain IK information.

add_sibling_node(self: alias_api.AlDagNode, sibling: alias_api.AlDagNode) → int: Insert an AlDagNode as the next sibling of this AlDagNode object.

affected_transformation_matrix(*args, **kwargs)

Overloaded function.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM, matrix: alias_api.AlTM) -> int

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM) -> Tuple[int, List[List[float[4]][4]]]

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

bounding_box(self: alias_api.AlDagNode) → Tuple[int, List[List[float[4]][8]]]: Returns the eight corners of the bounding box in world space.

cluster(*args, **kwargs)

Overloaded function.

cluster(self: alias_api.AlClusterNode) -> alias_api.AlCluster

Return a pointer to the attached AlCluster object.

cluster(self: alias_api.AlClusterNode, arg0: alias_api.AlTM) -> alias_api.AlCluster

Return the attached AlCluster object.

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

param tm

The transform matrix.

type tm

AlTM

return

The attached AlCluster object.

rtype

AlCluster

comment(self: alias_api.AlDagNode) → Tuple[int, int, str]: Obtain the size and address of a block of textual data associated with the object.

copy_object(*args, **kwargs)

Overloaded function.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions = None) -> alias_api.AlDagNode

Copy this AlDagNode returning a pointer to the new copy.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions, num_of_blind_data_ids_to_copy: int, blind_data_ids_to_copy: int) -> alias_api.AlDagNode

Return an exact duplicate of this AlDagNode wrapper.

copy_transform(self: alias_api.AlDagNode, node: alias_api.AlDagNode) → int: Copy the local transformation from the given node on to this node.

copy_wrapper(self: alias_api.AlClusterNode) → alias_api.AlObject: Return an exact duplicate of this AlClusterNode wrapper.

create_symmetric_geometry(self: alias_api.AlDagNode) → int: Create the symmetric geometry for this node if it is on a symmetric plane.

delete_object(self: alias_api.AlDagNode) → int: Delete the AlDagNode from the Alias Universe and return the status of the performed operation.

do_updates(self: alias_api.AlDagNode, new_state: int = 1) → int: The doUpdate flag is used to notify the system that you are finished performing. If this flag is True, then it is equivalent to sending out a ‘geometry modified’ message to the rest of the system.

get_surface_orientation(self: alias_api.AlDagNode) → Tuple[int, int]: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

global_transformation_matrix(*args, **kwargs)

Overloaded function.

global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the global transformation matrix for the object.

global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the global transformation matrix for the object.

inverse_global_transformation_matrix(*args, **kwargs)

Overloaded function.

inverse_global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the inverse global transformation matrix for the object.

inverse_global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the inverse global transformation matrix for the object.

is_a_construction_plane(self: alias_api.AlDagNode) → int: Return True if the dag node is a construction plane.

is_ancestor_an_instance(self: alias_api.AlDagNode) → int: Returns True if this AlDagNode or one of its ancestors is an instance node, else False.

is_display_mode_set(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType) → int: Return true if the specified display mode is set (on), else false.

is_instanceable(self: alias_api.AlClusterNode) → int: Return False. An AlClusterNode is not instanceable.

is_instanced(self: alias_api.AlDagNode) → int: Return True if this is an instance node.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

layer(self: alias_api.AlDagNode) → alias_api.AlLayer: Returns layer the node is assigned.

local_rotate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node rotation based on the setting of the local axes.

local_rotation_angles(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: These angles allow you to determine how the local rotation axis have been rotated from their initial position.

local_rotation_axes(self: alias_api.AlDagNode) → Tuple[int, List[float[3]], List[float[3]], List[float[3]]]: Return the vectors representing the local rotation axes for this node. These axes are the three axes vectors in the world space co-ordinates.

local_transformation_matrix(*args, **kwargs)

Overloaded function.

local_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the local transformation matrix for the object.

local_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the local transformation matrix for the object.

local_translate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node translation based on the setting of the local axes.

property name: Get or set the AlDagNode name.

next_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s next sibling AlDagNode or None if there is no next sibling.

parent_node(self: alias_api.AlDagNode) → AlGroupNode: Returns the parent group node.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s previous sibling AlDagNode or None if there is no next sibling.

remove_blind_data(self: alias_api.AlDagNode, user_type: int) → int: Remove the block of data of the given type from the object.

remove_comment(self: alias_api.AlDagNode) → int: Remove the block of text associated with this object from the object itself.

remove_joint(self: alias_api.AlDagNode) → int: Remove the AlJoint to this dag node to maintain IK information.

rotate_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the rotation pivot position in world space.

rotation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of rotation (in degrees) about the x, y, and z axes.

scale(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of scale in the x, y, and z direction.

scale_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the scale pivot position in world space.

search_across(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search across the DAG tree (starting at the current node), for a dag node with a specific ‘name’.

search_below(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search the DAG tree (rooted at the child of the current node), for a dag node with a specific ‘name’.

send_geometry_modified_message(self: alias_api.AlDagNode) → int: Send out an update message notifying that the geometry of this dag node has been modified.

set_blind_data(self: alias_api.AlDagNode, user_type: int, size: int, data: str) → int: Associates a block of ‘data’ with the object.

set_comment(self: alias_api.AlDagNode, size: int, data: str) → int: Associates a block of textual ‘data’ with the object.

set_display_mode(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType, on: int) → int: Set the display mode (by name) for this dag node.

set_layer(*args, **kwargs)

Overloaded function.

set_layer(self: alias_api.AlDagNode, layer: alias_api.AlLayer) -> int
Set the layer on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer

The layer object to be assigned to the AlDagNode

type layer

AlLayer

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)
set_layer(self: alias_api.AlDagNode, layer_number: int) -> int
Set the layer ID on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer_number

The layer number to be assigned to the AlDagNode

type layer_number

int

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer number is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)

set_local_rotation_angles(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Setting the local rotation angles is the only means by which the local rotations axes can be modified.

set_local_rotation_axes(self: alias_api.AlDagNode, arg0: List[float[3]], arg1: List[float[3]], arg2: List[float[3]]) → int: Set the local rotation axes of this dag node to the given world space vectors.

set_rotate_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the rotate pivot and return the status code result of the operation.

set_rotation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the amount of rotation (in degress) about the x, y, z axes. The rotation will be done after the scale transformation and before the final local translation.

set_scale(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the local scale vector. The scale transformation will be done before the local rotations. There is no restriction on the values of the components of the scale vector.

set_scale_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the scale pivot and return the status code result of the operation.

set_surface_orientation(self: alias_api.AlDagNode, flag: int) → int: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

set_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final local translation vector. The translation transformation will be done after rotations.

set_world_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final world translation vector.

translation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the final local translation vector.

type(self: alias_api.AlClusterNode) → alias_api.AlObjectType: Return the AlClusterNode type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

update_draw_info(self: alias_api.AlDagNode) → int: Force the internal draw information to be updated to match the dag node’s geometry.

version(self: alias_api.AlDagNode) → int: Return the version of the dag node.

AlConstructionEntity

class alias_api.AlConstructionEntity

Bases: alias_api.AlObject, alias_api.AlPickable

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlConstructionEntity) → alias_api.AlObject: Return an exact duplicate of this AlConstructionEntity wrapper.

delete_object(self: alias_api.AlConstructionEntity) → int: Delete the AlConstructionEntity from the Alias Universe and return the status of the performed operation.

property invisible: Get or set the AlConstructionEntity invisibility.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

property layer: Get or set the AlConstructionEntity layer.

property name: Get or set the AlConstructionEntity name.

pick(self: alias_api.AlPickable) → int: Pick the object

templated(self: alias_api.AlConstructionEntity) → int: On successfully checking the entity, return 1 if the AlConstructionEntity depends on anoather object which is templated, else return 0. On failure to check, return -1.

type(self: alias_api.AlConstructionEntity) → alias_api.AlObjectType: Return the AlConstructionEntity type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

AlConstructionPlane

class alias_api.AlConstructionPlane

Bases: alias_api.AlConstructionEntity

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlConstructionPlane) → alias_api.AlObject: Return an exact duplicate of this AlConstructionPlane wrapper.

create(self: alias_api.AlConstructionPlane, first: AlPoint, second: AlPoint, third: AlPoint) → int

delete_object(self: alias_api.AlConstructionEntity) → int: Delete the AlConstructionEntity from the Alias Universe and return the status of the performed operation.

property invisible: Get or set the AlConstructionEntity invisibility.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

property layer: Get or set the AlConstructionEntity layer.

property name: Get or set the AlConstructionEntity name.

pick(self: alias_api.AlPickable) → int: Pick the object

templated(self: alias_api.AlConstructionEntity) → int: On successfully checking the entity, return 1 if the AlConstructionEntity depends on anoather object which is templated, else return 0. On failure to check, return -1.

type(self: alias_api.AlConstructionPlane) → alias_api.AlObjectType: Return the AlConstructionPlane type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

AlCurveNode

class alias_api.AlCurveNode

add_joint(self: alias_api.AlDagNode) → int: Add an AlJoint to this dag node to maintain IK information.

add_sibling_node(self: alias_api.AlDagNode, sibling: alias_api.AlDagNode) → int: Insert an AlDagNode as the next sibling of this AlDagNode object.

affected_transformation_matrix(*args, **kwargs)

Overloaded function.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM, matrix: alias_api.AlTM) -> int

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM) -> Tuple[int, List[List[float[4]][4]]]

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

bounding_box(self: alias_api.AlDagNode) → Tuple[int, List[List[float[4]][8]]]: Returns the eight corners of the bounding box in world space.

comment(self: alias_api.AlDagNode) → Tuple[int, int, str]: Obtain the size and address of a block of textual data associated with the object.

copy_object(*args, **kwargs)

Overloaded function.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions = None) -> alias_api.AlDagNode

Copy this AlDagNode returning a pointer to the new copy.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions, num_of_blind_data_ids_to_copy: int, blind_data_ids_to_copy: int) -> alias_api.AlDagNode

Return an exact duplicate of this AlDagNode wrapper.

copy_transform(self: alias_api.AlDagNode, node: alias_api.AlDagNode) → int: Copy the local transformation from the given node on to this node.

copy_wrapper(self: alias_api.AlCurveNode) → alias_api.AlObject: Return an exact duplicate of this AlCurveNode wrapper.

create(self: alias_api.AlCurveNode, curve: alias_api.AlCurve) → int

Allocate the dag node for this object and attach it to the given AlCurve ‘curve’.

This method should only be called once for any AlCurve. It is an error to this method twice or if the object has been read in from a wire file.

Parameters: curve (AlCurve) – The curve to create the curve node from.
Returns: The status code from performing the operation AlStatusCode.Success - successful AlStatusCode.InvalidArgument - the new curve was invalid or None AlStatusCode.AlreadyCreated - the curve was already created elsewhere AlStatusCode.InsufficientMemory - if not enough memory available
Return type: statusCode

create_symmetric_geometry(self: alias_api.AlDagNode) → int: Create the symmetric geometry for this node if it is on a symmetric plane.

curve(*args, **kwargs)

Overloaded function.

curve(self: alias_api.AlCurveNode) -> alias_api.AlCurve

Return the curve data structure which can be used to acces the geometry of the curve.

curve(self: alias_api.AlCurveNode, tm: alias_api.AlTM) -> alias_api.AlCurve

Return the curve data structure which can be used to acces the geometry of the curve.

The AlTM ‘tm’ will be updated with the curve node’s transformation matrix, if a curve exists.

delete_object(self: alias_api.AlCurveNode) → int: Delete the AlCurveNode from the Alias Universe and return the status of the performed operation.

do_updates(self: alias_api.AlDagNode, new_state: int = 1) → int: The doUpdate flag is used to notify the system that you are finished performing. If this flag is True, then it is equivalent to sending out a ‘geometry modified’ message to the rest of the system.

get_surface_orientation(self: alias_api.AlDagNode) → Tuple[int, int]: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

global_transformation_matrix(*args, **kwargs)

Overloaded function.

global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the global transformation matrix for the object.

global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the global transformation matrix for the object.

inverse_global_transformation_matrix(*args, **kwargs)

Overloaded function.

inverse_global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the inverse global transformation matrix for the object.

inverse_global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the inverse global transformation matrix for the object.

is_a_construction_plane(self: alias_api.AlDagNode) → int: Return True if the dag node is a construction plane.

is_ancestor_an_instance(self: alias_api.AlDagNode) → int: Returns True if this AlDagNode or one of its ancestors is an instance node, else False.

is_display_mode_set(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType) → int: Return true if the specified display mode is set (on), else false.

is_instanceable(self: alias_api.AlDagNode) → int: Return True. An AlDagNode is instanceable by default, unless overridden by derived class.

is_instanced(self: alias_api.AlDagNode) → int: Return True if this is an instance node.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

join(self: alias_api.AlCurveNode, curve_node: alias_api.AlCurveNode) → alias_api.AlCurveNodeJoinErrors

Join the passed in curve node’s curve to the end of this curve, if the end is coincident with the beginning of the curve node’s curve.

This is most useful when using curves with attributes.

Warning: this operator will remove this curve’s CVs from all clusters and sets but not the curve node that is passed in. This means that all AlClusterMembers’ and AlSetMembers’ of this curves CVs will no longer be valid after a join. Further all AlCurveCVs and attribteus on ‘this’ AlCurve will have been deleted and regenerated (the passed curve is unchanged).

If the return value is etiher AlCurveNodeJoinErrors.Success or AlCurveNodeJoinErrors.Failure then all pointers to this curve’s AlCurveCVs will be invalid.

If the return value is AlCurveNodeJoinErrors.DuplicateCurve, AlCurveNodeJoinErrors.BadData, AlCurveNodeJoinErrors.NoAttribute, or AlCurveNodeJoinErrors.InvalidKeyPoints the model will not have been modified.

If the return value is AlCurveNodeJoinErrors.BadCluster all AlCurveCVs below this AlCurveNode will have been removed from all sets and clusters and the cluster effects may have been applied to some CVs.

Finally if the return value is AlCurveNodeJoinErrors.Failure all AlCurveCVs below this AlCurveNode will have been removed from all sets and clusters, all AlCurveCVs have been deleted and recreated, existing AlAttributes have been moved to the garbage list and new ones created and a join was attempted but failed, perhaps because the ends of the two curves did not overlap.

Parameters: curve_node (AlCurveNode) – A curve that will be added to the end of this curve.
Returns: The status code from performing the operation AlCurveNodeJoinErrors.Success - all OK, the join successed. AlCurveNodeJoinErrors.Failure - the join failed, perhaps because the end points didn’t overlap. AlCurveNodeJoinErrors.BadCluster - failed to remove effect of all clusters. AlCurveNodeJoinErrors.InvalidKeyPoints - one curve may have been a circle. AlCurveNodeJoinErrors.NoAttributes - coudln’t find or create attribteus for a curve. AlCurveNodeJoinErrors.BadData - the model is in an incorrect state. AlCurveNodeJoinErrors.DuplicateCurve - tried joining a curve to itself.
Return type: AlCurveNodeJoinErrors

layer(self: alias_api.AlDagNode) → alias_api.AlLayer: Returns layer the node is assigned.

local_rotate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node rotation based on the setting of the local axes.

local_rotation_angles(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: These angles allow you to determine how the local rotation axis have been rotated from their initial position.

local_rotation_axes(self: alias_api.AlDagNode) → Tuple[int, List[float[3]], List[float[3]], List[float[3]]]: Return the vectors representing the local rotation axes for this node. These axes are the three axes vectors in the world space co-ordinates.

local_transformation_matrix(*args, **kwargs)

Overloaded function.

local_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the local transformation matrix for the object.

local_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the local transformation matrix for the object.

local_translate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node translation based on the setting of the local axes.

property name: Get or set the AlDagNode name.

next_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s next sibling AlDagNode or None if there is no next sibling.

parent_node(self: alias_api.AlDagNode) → AlGroupNode: Returns the parent group node.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s previous sibling AlDagNode or None if there is no next sibling.

remove_blind_data(self: alias_api.AlDagNode, user_type: int) → int: Remove the block of data of the given type from the object.

remove_comment(self: alias_api.AlDagNode) → int: Remove the block of text associated with this object from the object itself.

remove_joint(self: alias_api.AlDagNode) → int: Remove the AlJoint to this dag node to maintain IK information.

rotate_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the rotation pivot position in world space.

rotation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of rotation (in degrees) about the x, y, and z axes.

scale(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of scale in the x, y, and z direction.

scale_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the scale pivot position in world space.

search_across(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search across the DAG tree (starting at the current node), for a dag node with a specific ‘name’.

search_below(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search the DAG tree (rooted at the child of the current node), for a dag node with a specific ‘name’.

send_geometry_modified_message(self: alias_api.AlDagNode) → int: Send out an update message notifying that the geometry of this dag node has been modified.

set_blind_data(self: alias_api.AlDagNode, user_type: int, size: int, data: str) → int: Associates a block of ‘data’ with the object.

set_comment(self: alias_api.AlDagNode, size: int, data: str) → int: Associates a block of textual ‘data’ with the object.

set_display_mode(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType, on: int) → int: Set the display mode (by name) for this dag node.

set_layer(*args, **kwargs)

Overloaded function.

set_layer(self: alias_api.AlDagNode, layer: alias_api.AlLayer) -> int
Set the layer on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer

The layer object to be assigned to the AlDagNode

type layer

AlLayer

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)
set_layer(self: alias_api.AlDagNode, layer_number: int) -> int
Set the layer ID on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer_number

The layer number to be assigned to the AlDagNode

type layer_number

int

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer number is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)

set_local_rotation_angles(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Setting the local rotation angles is the only means by which the local rotations axes can be modified.

set_local_rotation_axes(self: alias_api.AlDagNode, arg0: List[float[3]], arg1: List[float[3]], arg2: List[float[3]]) → int: Set the local rotation axes of this dag node to the given world space vectors.

set_rotate_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the rotate pivot and return the status code result of the operation.

set_rotation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the amount of rotation (in degress) about the x, y, z axes. The rotation will be done after the scale transformation and before the final local translation.

set_scale(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the local scale vector. The scale transformation will be done before the local rotations. There is no restriction on the values of the components of the scale vector.

set_scale_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the scale pivot and return the status code result of the operation.

set_surface_orientation(self: alias_api.AlDagNode, flag: int) → int: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

set_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final local translation vector. The translation transformation will be done after rotations.

set_world_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final world translation vector.

translation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the final local translation vector.

type(self: alias_api.AlCurveNode) → alias_api.AlObjectType: Return the AlCurveNode type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

update_draw_info(self: alias_api.AlDagNode) → int: Force the internal draw information to be updated to match the dag node’s geometry.

version(self: alias_api.AlDagNode) → int: Return the version of the dag node.

AlCurveOnSurface

class alias_api.AlCurveOnSurface

Bases: alias_api.AlObject, alias_api.AlPickable

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

control_point(self: alias_api.AlCurveOnSurface, index: int) → Tuple[int, std::array<double,4>]

Given a valid index, return the value of the control point in ‘point’.

A valid index is one in the range 0 to numberOfControlPoints()-1.

Note the control point is represented by the quadruple [u v 0.0 w], where “u” and “v” represent the control point in U-V parameter space, the “0.0” is unused, and the “w” is the homogeneous coordinate.

Parameters

index (int) – A valid index of the control point to return.

Returns

A tuple containing (1) the status code result of the operation:: Success - the control point was returned InvalidArgument - the index was not valid or ‘point’ was NULL InvalidObject - the curve was invalid Failure - an error occurred

and (2) the control point value.

Return type

tuple

copy_wrapper(self: alias_api.AlCurveOnSurface) → alias_api.AlObject: Return an exact duplicate of this AlCurveOnSurface wrapper.

degree(self: alias_api.AlCurveOnSurface) → int: Return the degree of the curve. Return -1 if the curve is not valid.

delete_object(self: alias_api.AlCurveOnSurface) → int: Delete the AlCurveOnSurface from the Alias Universe and return the status of the performed operation.

form(self: alias_api.AlCurveOnSurface) → alias_api.AlCurveFormType

Return the form of the curve, which is kOpen, kClosed or kPeriodic.

If a curve on surface is periodic, it is tangent continuous at the point where it is closed. (If you use the “close” menu item in the interactive Alias pacakge, you actually make a curve periodic.) If a curve is periodic, it implies that it is closed. If a curve is kClosed, then it just means that its endpoints are coincident. Otherwise, the curve is kOpen.”

in_trim(self: alias_api.AlCurveOnSurface) → int: Returns True if this curve on surface is being used to trim the surface it is on, else False.

insert(self: alias_api.AlCurveOnSurface, parametric_value: float) → int

Insert an edit point into the curve.

Parameters: parametric_value (float) – The parametric value of the new edit point on the curve.
Returns: The status code result of the operation: Success - the operation was successful InvalidObject - the given object is not valid InvalidArgument - parametric_value is out of bounds Failre - an error occurred
Return type: int(AlStatusCode)

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

knot_value(self: alias_api.AlCurveOnSurface, index: int) → float

Given a valid knot index, return the value of the knot in ‘knotValue’.

A valid knot index is one in the range of 0 - numberOfKnots()-1.

Parameters: index (int) – A valid index of hte knot value to return.
Returns: The value of the knot for the given index.
Return type: float

property name: Get or set the object name.

next_curve_on_surface(self: alias_api.AlCurveOnSurface) → alias_api.AlCurveOnSurface: Return the next curve on surface in the list of curves on surfaces that are attached to a specific surface. Return None if there is no next curve on surface.

number_of_control_points(self: alias_api.AlCurveOnSurface) → int: Return the number of control points.

number_of_knots(self: alias_api.AlCurveOnSurface) → int: Return the number of knots (just number of spans + 1). Return -1 if the curve is not valid.

number_of_spans(self: alias_api.AlCurveOnSurface) → int: Return the number of spans in the curve. Return -1 if the curve is not valid.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_curve_on_surface(self: alias_api.AlCurveOnSurface) → alias_api.AlCurveOnSurface: Return the previous curve on surface in the list of curves on surfaces that are attached to a specific surface. Return None if there is no next curve on surface.

real_number_of_knots(self: alias_api.AlCurveOnSurface) → int: Return the actual number of knots on the curve. That is number_of_spans + 2*degree -1. Return -1 if the operation failed.

reverse(self: alias_api.AlCurveOnSurface) → int: Reverse the direction of this curve on surface.

set_control_point(self: alias_api.AlCurveOnSurface, index: int, point: std::array<double, 4>) → int

Given a valid index, set the value of the control point in ‘point’.

A valid index is one in the range 0 to numberOfControlPoints()-1.

Note the control point is represented by the quadruple [u v 0.0 w], where “u” and “v” represent the control point in U-V parameter space, the “0.0” is unused, and the “w” is the homogeneous coordinate.

Parameters: index (int) – A valid index of the control point to set.
Returns: The status code result of the operation: Success - the control point was returned InvalidArgument - the index was not valid or ‘point’ was NULL InvalidObject - the curve was invalid Failure - an error occurred
Return type: int(AlStatusCode)

set_knot_value(self: alias_api.AlCurveOnSurface, index: int, knot_value: float) → int

Given a valid knot index, set the value of hte knot to be ‘knotValue’.

A valid knot index is one in the range of 0 - numberOfKnots()-1.

Parameters

index (int) – A valid index of hte knot value to set.
knot_value (float) – The knot value to set.

Returns

The status code result of the operation Success - the knot value was set InvalidArgument - the ‘index’ was not in the range 0…#knots-1 InvalidObject - the curve was invalid AlreadyCreated - the curve was already in a trim Failure - an internal error occured

Return type

set_visible(self: alias_api.AlCurveOnSurface, visible: int) → int: Set the visibility of the curve on surface.

surface(self: alias_api.AlCurveOnSurface) → AlSurface: Return the surface that this curve is on.

type(self: alias_api.AlCurveOnSurface) → alias_api.AlObjectType: Return the AlCurveOnSurface type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

visible(self: alias_api.AlCurveOnSurface) → int: Return True if this curve is visible, else False if it is invisible.

AlCurveOnSurfacePoint

class alias_api.AlCurveOnSurfacePoint

arc_length(self: alias_api.AlCurveOnSurfacePoint) → Tuple[int, float]

Find the length of the curve on surface on which the point is present.

Returns

A tuple (status, arg_len), where status [AlStatusCode] - the status code result

Success - the arc length was found InvalidObject - the point is not valid

arc_len [float] - the length of the curve

Return type

tuple

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

attached_to(self: alias_api.AlCurveOnSurfacePoint) → alias_api.AlCurveOnSurface: Return the AlCurveOnSurface this AlCurveOnSurfacePoint is associated with.

copy_wrapper(self: alias_api.AlCurveOnSurfacePoint) → alias_api.AlObject: Return an exact duplicate of this AlCurveOnSurfacePoint wrapper.

create(self: alias_api.AlCurveOnSurfacePoint, curve_on_surface: alias_api.AlCurveOnSurface, u: float) → int

Create an AlCurveOnSurfacePoint on the given AlCurveOnSurface.

Parameters

curve_on_surface (AlCurveOnSurface) – The curve on surface on which the point is to be created.
u (float) – The parameter at which point is to be created.

Returns

The status code Success - the point was successfully created. AlreadyCreated - object has already been created. Failure - the point could not be created on the curve on surface. InvalidArgument - the curve is not a valid object.

Return type

AlStatusCode

delete_object(self: alias_api.AlConstructionEntity) → int: Delete the AlConstructionEntity from the Alias Universe and return the status of the performed operation.

property invisible: Get or set the AlConstructionEntity invisibility.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

property layer: Get or set the AlConstructionEntity layer.

property name: Get or set the AlConstructionEntity name.

normal1(self: alias_api.AlCurveOnSurfacePoint) → Tuple[int, float, float, float]

Find the normal vector to the curve on surface at the point.

Returns

A tuple (status, x, y, z), where status [AlStatusCode] - the status code result

Success - the normal was found InvalidObject - the point is not valid

x [float] - the x coordinate of the normal y [float] - the y coordinate of the normal z [float] - the z coordinate of the normal

Return type

tuple

normal2(self: alias_api.AlCurveOnSurfacePoint) → Tuple[int, float, float, float]

Find the second normal vector to the curve on surface at the point.

Returns

A tuple (status, x, y, z), where status [AlStatusCode] - the status code result

Success - the normal was found InvalidObject - the point is not valid

x [float] - the x coordinate of the second normal y [float] - the y coordinate of the second normal z [float] - the z coordinate of the second normal

Return type

tuple

parameter(self: alias_api.AlCurveOnSurfacePoint) → Tuple[int, float]

Find the parameter value at which the point is present.

Returns

A tuple (status, u), where status [AlStatusCode] - the status code result

Success - the parameter was found InvalidObject - the point is not valid

u [float] - the curve parameter where point is present

Return type

tuple

pick(self: alias_api.AlPickable) → int: Pick the object

set_parameter(self: alias_api.AlCurveOnSurfacePoint, u: float) → int

Move the position of a point created on a curve on surface.

Parameters: u (float) – The parameter on the curve on surface where the point has to be moved.
Returns: The status code result Success - the point was moved InvalidObject - the point is not valid
Return type: AlStatuscode

tangent(self: alias_api.AlCurveOnSurfacePoint) → Tuple[int, float, float, float]

Find the tangent vector to the curve on surface at the point.

Returns

A tuple (status, x, y, z), where status [AlStatusCode] - the status code result

Success - the tangent was found InvalidObject - the point is not valid

x [float] - the x coordinate of the tangent y [float] - the y coordinate of the tangent z [float] - the z coordinate of the tangent

Return type

tuple

templated(self: alias_api.AlConstructionEntity) → int: On successfully checking the entity, return 1 if the AlConstructionEntity depends on anoather object which is templated, else return 0. On failure to check, return -1.

type(self: alias_api.AlCurveOnSurfacePoint) → alias_api.AlObjectType: Return the AlCurveOnSurfacePoint type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

worldPosition(self: alias_api.AlPoint, x: float, y: float, z: float) → int: Return the world coordinates of the AlPoint.

world_position(self: alias_api.AlCurveOnSurfacePoint) → Tuple[int, float, float, float]

Find the world coordinates of the point.

Returns

A tuple (status, x, y, z), where status [AlStatusCode] - the status code result

Success - the coordinates was found InvalidObject - the point is not valid

x [float] - the x world coordinate of the point y [float] - the y world coordinate of the point z [float] - the z world coordinate of the point

Return type

tuple

AlCurvePoint

class alias_api.AlCurvePoint

arc_length(self: alias_api.AlCurvePoint) → Tuple[int, float]

Find the length of the curve on which the point is present.

Returns

A tuple (status, arg_len), where status [AlStatusCode] - the status code result

Success - the arc length was found InvalidObject - the point is not valid

arc_len [float] - the length of the curve

Return type

tuple

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

attached_to(self: alias_api.AlCurvePoint) → alias_api.AlCurveNode: Return the AlCurveNode this AlCurvePoint is associated with.

copy_wrapper(self: alias_api.AlCurvePoint) → alias_api.AlObject: Return an exact duplicate of this AlCurvePoint wrapper.

create(self: alias_api.AlCurvePoint, curve: alias_api.AlCurve, u: float) → int

Create a point on the given curve.

Parameters

curve (AlCurve) – The curve on which the point is to be created.
u (float) – The curve parameter at which point is to be created.

Returns

The status code Success - the point was successfully created. AlreadyCreated - object has already been created. Failure - the point could not be created on the curve. InvalidArgument - the curve is not a valid object.

Return type

AlStatusCode

delete_object(self: alias_api.AlConstructionEntity) → int: Delete the AlConstructionEntity from the Alias Universe and return the status of the performed operation.

property invisible: Get or set the AlConstructionEntity invisibility.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

property layer: Get or set the AlConstructionEntity layer.

property name: Get or set the AlConstructionEntity name.

normal1(self: alias_api.AlCurvePoint) → Tuple[int, float, float, float]

Find the normal vector to the curve at the point.

Returns

A tuple (status, x, y, z), where status [AlStatusCode] - the status code result

Success - the normal was found InvalidObject - the point is not valid

x [float] - the x coordinate of the normal y [float] - the y coordinate of the normal z [float] - the z coordinate of the normal

Return type

tuple

normal2(self: alias_api.AlCurvePoint) → Tuple[int, float, float, float]

Find the second normal vector to the curve at the point.

Returns

A tuple (status, x, y, z), where status [AlStatusCode] - the status code result

Success - the normal was found InvalidObject - the point is not valid

x [float] - the x coordinate of the second normal y [float] - the y coordinate of the second normal z [float] - the z coordinate of the second normal

Return type

tuple

parameter(self: alias_api.AlCurvePoint) → Tuple[int, float]

Find the parameter value at which the point is present.

Returns

A tuple (status, u), where status [AlStatusCode] - the status code result

Success - the parameter was found InvalidObject - the point is not valid

u [float] - the curve parameter where point is present

Return type

tuple

pick(self: alias_api.AlPickable) → int: Pick the object

radius(self: alias_api.AlCurvePoint) → Tuple[int, float]

Find the radius of the curve at the point.

Returns

A tuple (status, radius), where status [AlStatusCode] - the status code result

Success - the radius was found InvalidObject - the point is not valid

radius [float] - the radius of the curve at the point

Return type

tuple

set_parameter(self: alias_api.AlCurvePoint, u: float) → int

Move the position of a point created on a curve.

Parameters: u (float) – The parameter on the curve where the point has to be moved.
Returns: The status code result Success - the point was moved InvalidObject - the point is not valid
Return type: AlStatuscode

tangent(self: alias_api.AlCurvePoint) → Tuple[int, float, float, float]

Find the tangent vector to the curve at the point.

Returns

A tuple (status, x, y, z), where status [AlStatusCode] - the status code result

Success - the tangent was found InvalidObject - the point is not valid

x [float] - the x coordinate of the tangent y [float] - the y coordinate of the tangent z [float] - the z coordinate of the tangent

Return type

tuple

templated(self: alias_api.AlConstructionEntity) → int: On successfully checking the entity, return 1 if the AlConstructionEntity depends on anoather object which is templated, else return 0. On failure to check, return -1.

type(self: alias_api.AlCurvePoint) → alias_api.AlObjectType: Return the AlCurvePoint type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

worldPosition(self: alias_api.AlPoint, x: float, y: float, z: float) → int: Return the world coordinates of the AlPoint.

world_position(self: alias_api.AlCurvePoint) → Tuple[int, float, float, float]

Find the world coordinates of the point.

Returns

A tuple (status, x, y, z), where status [AlStatusCode] - the status code result

Success - the coordinates was found InvalidObject - the point is not valid

x [float] - the x world coordinate of the point y [float] - the y world coordinate of the point z [float] - the z world coordinate of the point

Return type

tuple

AlDagNode

class alias_api.AlDagNode

Bases: alias_api.AlObject, alias_api.AlPickable

add_joint(self: alias_api.AlDagNode) → int: Add an AlJoint to this dag node to maintain IK information.

add_sibling_node(self: alias_api.AlDagNode, sibling: alias_api.AlDagNode) → int: Insert an AlDagNode as the next sibling of this AlDagNode object.

affected_transformation_matrix(*args, **kwargs)

Overloaded function.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM, matrix: alias_api.AlTM) -> int

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM) -> Tuple[int, List[List[float[4]][4]]]

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

bounding_box(self: alias_api.AlDagNode) → Tuple[int, List[List[float[4]][8]]]: Returns the eight corners of the bounding box in world space.

comment(self: alias_api.AlDagNode) → Tuple[int, int, str]: Obtain the size and address of a block of textual data associated with the object.

copy_object(*args, **kwargs)

Overloaded function.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions = None) -> alias_api.AlDagNode

Copy this AlDagNode returning a pointer to the new copy.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions, num_of_blind_data_ids_to_copy: int, blind_data_ids_to_copy: int) -> alias_api.AlDagNode

Return an exact duplicate of this AlDagNode wrapper.

copy_transform(self: alias_api.AlDagNode, node: alias_api.AlDagNode) → int: Copy the local transformation from the given node on to this node.

copy_wrapper(self: alias_api.AlDagNode) → alias_api.AlObject: Return an exact duplicate of this AlDagNode wrapper.

create_symmetric_geometry(self: alias_api.AlDagNode) → int: Create the symmetric geometry for this node if it is on a symmetric plane.

delete_object(self: alias_api.AlDagNode) → int: Delete the AlDagNode from the Alias Universe and return the status of the performed operation.

do_updates(self: alias_api.AlDagNode, new_state: int = 1) → int: The doUpdate flag is used to notify the system that you are finished performing. If this flag is True, then it is equivalent to sending out a ‘geometry modified’ message to the rest of the system.

get_surface_orientation(self: alias_api.AlDagNode) → Tuple[int, int]: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

global_transformation_matrix(*args, **kwargs)

Overloaded function.

global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the global transformation matrix for the object.

global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the global transformation matrix for the object.

inverse_global_transformation_matrix(*args, **kwargs)

Overloaded function.

inverse_global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the inverse global transformation matrix for the object.

inverse_global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the inverse global transformation matrix for the object.

is_a_construction_plane(self: alias_api.AlDagNode) → int: Return True if the dag node is a construction plane.

is_ancestor_an_instance(self: alias_api.AlDagNode) → int: Returns True if this AlDagNode or one of its ancestors is an instance node, else False.

is_display_mode_set(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType) → int: Return true if the specified display mode is set (on), else false.

is_instanceable(self: alias_api.AlDagNode) → int: Return True. An AlDagNode is instanceable by default, unless overridden by derived class.

is_instanced(self: alias_api.AlDagNode) → int: Return True if this is an instance node.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

layer(self: alias_api.AlDagNode) → alias_api.AlLayer: Returns layer the node is assigned.

local_rotate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node rotation based on the setting of the local axes.

local_rotation_angles(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: These angles allow you to determine how the local rotation axis have been rotated from their initial position.

local_rotation_axes(self: alias_api.AlDagNode) → Tuple[int, List[float[3]], List[float[3]], List[float[3]]]: Return the vectors representing the local rotation axes for this node. These axes are the three axes vectors in the world space co-ordinates.

local_transformation_matrix(*args, **kwargs)

Overloaded function.

local_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the local transformation matrix for the object.

local_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the local transformation matrix for the object.

local_translate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node translation based on the setting of the local axes.

property name: Get or set the AlDagNode name.

next_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s next sibling AlDagNode or None if there is no next sibling.

parent_node(self: alias_api.AlDagNode) → AlGroupNode: Returns the parent group node.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s previous sibling AlDagNode or None if there is no next sibling.

remove_blind_data(self: alias_api.AlDagNode, user_type: int) → int: Remove the block of data of the given type from the object.

remove_comment(self: alias_api.AlDagNode) → int: Remove the block of text associated with this object from the object itself.

remove_joint(self: alias_api.AlDagNode) → int: Remove the AlJoint to this dag node to maintain IK information.

rotate_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the rotation pivot position in world space.

rotation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of rotation (in degrees) about the x, y, and z axes.

scale(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of scale in the x, y, and z direction.

scale_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the scale pivot position in world space.

search_across(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search across the DAG tree (starting at the current node), for a dag node with a specific ‘name’.

search_below(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search the DAG tree (rooted at the child of the current node), for a dag node with a specific ‘name’.

send_geometry_modified_message(self: alias_api.AlDagNode) → int: Send out an update message notifying that the geometry of this dag node has been modified.

set_blind_data(self: alias_api.AlDagNode, user_type: int, size: int, data: str) → int: Associates a block of ‘data’ with the object.

set_comment(self: alias_api.AlDagNode, size: int, data: str) → int: Associates a block of textual ‘data’ with the object.

set_display_mode(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType, on: int) → int: Set the display mode (by name) for this dag node.

set_layer(*args, **kwargs)

Overloaded function.

set_layer(self: alias_api.AlDagNode, layer: alias_api.AlLayer) -> int
Set the layer on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer

The layer object to be assigned to the AlDagNode

type layer

AlLayer

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)
set_layer(self: alias_api.AlDagNode, layer_number: int) -> int
Set the layer ID on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer_number

The layer number to be assigned to the AlDagNode

type layer_number

int

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer number is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)

set_local_rotation_angles(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Setting the local rotation angles is the only means by which the local rotations axes can be modified.

set_local_rotation_axes(self: alias_api.AlDagNode, arg0: List[float[3]], arg1: List[float[3]], arg2: List[float[3]]) → int: Set the local rotation axes of this dag node to the given world space vectors.

set_rotate_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the rotate pivot and return the status code result of the operation.

set_rotation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the amount of rotation (in degress) about the x, y, z axes. The rotation will be done after the scale transformation and before the final local translation.

set_scale(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the local scale vector. The scale transformation will be done before the local rotations. There is no restriction on the values of the components of the scale vector.

set_scale_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the scale pivot and return the status code result of the operation.

set_surface_orientation(self: alias_api.AlDagNode, flag: int) → int: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

set_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final local translation vector. The translation transformation will be done after rotations.

set_world_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final world translation vector.

translation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the final local translation vector.

type(self: alias_api.AlDagNode) → alias_api.AlObjectType: Return the AlDagNode type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

update_draw_info(self: alias_api.AlDagNode) → int: Force the internal draw information to be updated to match the dag node’s geometry.

version(self: alias_api.AlDagNode) → int: Return the version of the dag node.

AlCopyOptions

class alias_api.AlCopyOptions

Bases: pybind11_builtins.pybind11_object

copy_animation(self: alias_api.AlCopyOptions) → int: Return True if copying of an AlDagNode’s animation is enabled.

copy_clusters(self: alias_api.AlCopyOptions) → int: Return True if the new copies of clusters should be made of clusters which reference geometry below the AlDagNode.

instance_copy(self: alias_api.AlCopyOptions) → int: Return True if the copies are to be instances of the AlDagNode rather than new objects.

num_copies(self: alias_api.AlCopyOptions) → int: Return the number of copies to be created. Zero will be returned if the AlCopyOptions object was not properly created.

rotation(self: alias_api.AlCopyOptions) → Tuple[int, float, float, float]: Return the rotation which will be applied to copies of the AlDagNode.

scale(self: alias_api.AlCopyOptions) → Tuple[int, float, float, float]: Return the scale which will be applied to copies of the AlDagNode.

set_copy_animation(self: alias_api.AlCopyOptions, animation: int) → int: If ‘animation’ is True, animation on the AlDagNode will be copied.

set_copy_clusters(self: alias_api.AlCopyOptions, clusters: int) → int: If ‘clusters’ is True, new copies of clusters will be created for clusters which reference geometry below the AlDagNode.

set_instance_copy(self: alias_api.AlCopyOptions, instance: int) → int: If ‘instance’ is True, instances of the AlDagNode will be created rather than new objects.

set_num_copies(self: alias_api.AlCopyOptions, arg0: int) → int: Sets the number of copies to create.

set_rotation(self: alias_api.AlCopyOptions, x: float, y: float, z: float) → int: Set the rotation which will be applied to copies of the AlDagNode.

set_scale(self: alias_api.AlCopyOptions, x: float, y: float, z: float) → int: Set the scale which will be applied to copies of the AlDagNode.

set_time_offset(self: alias_api.AlCopyOptions, arg0: float) → int: Sets the time offset for copies when copying animation.

set_translation(self: alias_api.AlCopyOptions, x: float, y: float, z: float) → int: Set the translation which will be applied to copies of the AlDagNode.

time_offset(self: alias_api.AlCopyOptions) → float: Return the time offset for the copies if animation is being copied.

translation(self: alias_api.AlCopyOptions) → Tuple[int, float, float, float]: Return the translation which will be applied to copies of the AlDagNode.

AlFace

class alias_api.AlFace

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlFace) → alias_api.AlObject: Return an exact duplicate of this AlFace wrapper.

delete_object(self: alias_api.AlFace) → int: Delete the AlFace from the Alias Universe and return the status of the performed operation.

face_node(self: alias_api.AlFace) → AlFaceNode: Return the face node associated with this face.

first_shader(self: alias_api.AlFace) → AlShader: Return the first shader that this face object references.

get_layered_shader(self: alias_api.AlFace) → AlLayeredShader: Return the layered shader that this face object references.

get_switch_shader(self: alias_api.AlFace) → AlSwitchShader: Return the switch shader that this face object references.

property name: Get or set the object name.

next_face(self: alias_api.AlFace) → alias_api.AlFace: Return a pointer to the next face in the list of faces.

next_shader(self: alias_api.AlFace, shader: AlShader) → AlShader: Return the shader after the given shader in the shader list. Specify None as the shader parameter will return the first shader.

prev_face(self: alias_api.AlFace) → alias_api.AlFace: Return a pointer to the previous face in the list of faces.

type(self: alias_api.AlFace) → alias_api.AlObjectType: Return the AlFace type identifier.

AlFaceNode

class alias_api.AlFaceNode

Bases: alias_api.AlCurveNode

add_face(self: alias_api.AlFaceNode, face: alias_api.AlFace) → int: Add a face to the end of the list of faces. The face must not already belong to another face node.

add_joint(self: alias_api.AlDagNode) → int: Add an AlJoint to this dag node to maintain IK information.

add_sibling_node(self: alias_api.AlDagNode, sibling: alias_api.AlDagNode) → int: Insert an AlDagNode as the next sibling of this AlDagNode object.

affected_transformation_matrix(*args, **kwargs)

Overloaded function.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM, matrix: alias_api.AlTM) -> int

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM) -> Tuple[int, List[List[float[4]][4]]]

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

bounding_box(self: alias_api.AlDagNode) → Tuple[int, List[List[float[4]][8]]]: Returns the eight corners of the bounding box in world space.

comment(self: alias_api.AlDagNode) → Tuple[int, int, str]: Obtain the size and address of a block of textual data associated with the object.

convert_to_trimmed_surface(self: alias_api.AlFaceNode, world_space: int = False) → alias_api.AlSurface: Return an AlSurface that represents the AlFace geometry converted to a trimmed surface. Return None if the AlFace geometry is invalid for any reason. A trimmed surface will not be created if the AlFace curves are non-planar or intersecting.

copy_object(*args, **kwargs)

Overloaded function.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions = None) -> alias_api.AlDagNode

Copy this AlDagNode returning a pointer to the new copy.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions, num_of_blind_data_ids_to_copy: int, blind_data_ids_to_copy: int) -> alias_api.AlDagNode

Return an exact duplicate of this AlDagNode wrapper.

copy_transform(self: alias_api.AlDagNode, node: alias_api.AlDagNode) → int: Copy the local transformation from the given node on to this node.

copy_wrapper(self: alias_api.AlFaceNode) → alias_api.AlObject: Return an exact duplicate of this AlFaceNode wrapper.

create(self: alias_api.AlFaceNode, face: alias_api.AlFace) → int: This method allocates teh dag node for the AlFaceNode. It adds the given face as the first face of the face node.

create_symmetric_geometry(self: alias_api.AlDagNode) → int: Create the symmetric geometry for this node if it is on a symmetric plane.

curve(*args, **kwargs)

Overloaded function.

curve(self: alias_api.AlCurveNode) -> alias_api.AlCurve

Return the curve data structure which can be used to acces the geometry of the curve.

curve(self: alias_api.AlCurveNode, tm: alias_api.AlTM) -> alias_api.AlCurve

Return the curve data structure which can be used to acces the geometry of the curve.

The AlTM ‘tm’ will be updated with the curve node’s transformation matrix, if a curve exists.

delete_object(self: alias_api.AlCurveNode) → int: Delete the AlCurveNode from the Alias Universe and return the status of the performed operation.

do_updates(self: alias_api.AlDagNode, new_state: int = 1) → int: The doUpdate flag is used to notify the system that you are finished performing. If this flag is True, then it is equivalent to sending out a ‘geometry modified’ message to the rest of the system.

first_face(*args, **kwargs)

Overloaded function.

first_face(self: alias_api.AlFaceNode) -> alias_api.AlFace

Return the first face in the list of faces.

first_face(self: alias_api.AlFaceNode, tm: alias_api.AlTM) -> alias_api.AlFace

Return the first face in the list of faces and update the ‘tm’ with the face node’s transformation matrix.

get_surface_orientation(self: alias_api.AlDagNode) → Tuple[int, int]: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

global_transformation_matrix(*args, **kwargs)

Overloaded function.

global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the global transformation matrix for the object.

global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the global transformation matrix for the object.

inverse_global_transformation_matrix(*args, **kwargs)

Overloaded function.

inverse_global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the inverse global transformation matrix for the object.

inverse_global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the inverse global transformation matrix for the object.

is_a_construction_plane(self: alias_api.AlDagNode) → int: Return True if the dag node is a construction plane.

is_ancestor_an_instance(self: alias_api.AlDagNode) → int: Returns True if this AlDagNode or one of its ancestors is an instance node, else False.

is_display_mode_set(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType) → int: Return true if the specified display mode is set (on), else false.

is_instanceable(self: alias_api.AlDagNode) → int: Return True. An AlDagNode is instanceable by default, unless overridden by derived class.

is_instanced(self: alias_api.AlDagNode) → int: Return True if this is an instance node.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

join(self: alias_api.AlCurveNode, curve_node: alias_api.AlCurveNode) → alias_api.AlCurveNodeJoinErrors

Join the passed in curve node’s curve to the end of this curve, if the end is coincident with the beginning of the curve node’s curve.

This is most useful when using curves with attributes.

Warning: this operator will remove this curve’s CVs from all clusters and sets but not the curve node that is passed in. This means that all AlClusterMembers’ and AlSetMembers’ of this curves CVs will no longer be valid after a join. Further all AlCurveCVs and attribteus on ‘this’ AlCurve will have been deleted and regenerated (the passed curve is unchanged).

If the return value is etiher AlCurveNodeJoinErrors.Success or AlCurveNodeJoinErrors.Failure then all pointers to this curve’s AlCurveCVs will be invalid.

If the return value is AlCurveNodeJoinErrors.DuplicateCurve, AlCurveNodeJoinErrors.BadData, AlCurveNodeJoinErrors.NoAttribute, or AlCurveNodeJoinErrors.InvalidKeyPoints the model will not have been modified.

If the return value is AlCurveNodeJoinErrors.BadCluster all AlCurveCVs below this AlCurveNode will have been removed from all sets and clusters and the cluster effects may have been applied to some CVs.

Finally if the return value is AlCurveNodeJoinErrors.Failure all AlCurveCVs below this AlCurveNode will have been removed from all sets and clusters, all AlCurveCVs have been deleted and recreated, existing AlAttributes have been moved to the garbage list and new ones created and a join was attempted but failed, perhaps because the ends of the two curves did not overlap.

Parameters: curve_node (AlCurveNode) – A curve that will be added to the end of this curve.
Returns: The status code from performing the operation AlCurveNodeJoinErrors.Success - all OK, the join successed. AlCurveNodeJoinErrors.Failure - the join failed, perhaps because the end points didn’t overlap. AlCurveNodeJoinErrors.BadCluster - failed to remove effect of all clusters. AlCurveNodeJoinErrors.InvalidKeyPoints - one curve may have been a circle. AlCurveNodeJoinErrors.NoAttributes - coudln’t find or create attribteus for a curve. AlCurveNodeJoinErrors.BadData - the model is in an incorrect state. AlCurveNodeJoinErrors.DuplicateCurve - tried joining a curve to itself.
Return type: AlCurveNodeJoinErrors

layer(self: alias_api.AlDagNode) → alias_api.AlLayer: Returns layer the node is assigned.

local_rotate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node rotation based on the setting of the local axes.

local_rotation_angles(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: These angles allow you to determine how the local rotation axis have been rotated from their initial position.

local_rotation_axes(self: alias_api.AlDagNode) → Tuple[int, List[float[3]], List[float[3]], List[float[3]]]: Return the vectors representing the local rotation axes for this node. These axes are the three axes vectors in the world space co-ordinates.

local_transformation_matrix(*args, **kwargs)

Overloaded function.

local_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the local transformation matrix for the object.

local_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the local transformation matrix for the object.

local_translate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node translation based on the setting of the local axes.

property name: Get or set the AlDagNode name.

next_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s next sibling AlDagNode or None if there is no next sibling.

normal(self: alias_api.AlFaceNode) → Tuple[int, float, float, float]: Attempts to calculate the overall normal of all teh face curves in this face.

parent_node(self: alias_api.AlDagNode) → AlGroupNode: Returns the parent group node.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s previous sibling AlDagNode or None if there is no next sibling.

remove_blind_data(self: alias_api.AlDagNode, user_type: int) → int: Remove the block of data of the given type from the object.

remove_comment(self: alias_api.AlDagNode) → int: Remove the block of text associated with this object from the object itself.

remove_face(self: alias_api.AlFaceNode, face: alias_api.AlFace) → int: Remove a face from the list of faces. This must not be the last face under the face node. When the face is removed from under the face node, it is no longer part of the universe taht would be stored.

remove_joint(self: alias_api.AlDagNode) → int: Remove the AlJoint to this dag node to maintain IK information.

rotate_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the rotation pivot position in world space.

rotation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of rotation (in degrees) about the x, y, and z axes.

scale(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of scale in the x, y, and z direction.

scale_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the scale pivot position in world space.

search_across(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search across the DAG tree (starting at the current node), for a dag node with a specific ‘name’.

search_below(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search the DAG tree (rooted at the child of the current node), for a dag node with a specific ‘name’.

send_geometry_modified_message(self: alias_api.AlDagNode) → int: Send out an update message notifying that the geometry of this dag node has been modified.

set_blind_data(self: alias_api.AlDagNode, user_type: int, size: int, data: str) → int: Associates a block of ‘data’ with the object.

set_comment(self: alias_api.AlDagNode, size: int, data: str) → int: Associates a block of textual ‘data’ with the object.

set_display_mode(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType, on: int) → int: Set the display mode (by name) for this dag node.

set_layer(*args, **kwargs)

Overloaded function.

set_layer(self: alias_api.AlDagNode, layer: alias_api.AlLayer) -> int
Set the layer on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer

The layer object to be assigned to the AlDagNode

type layer

AlLayer

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)
set_layer(self: alias_api.AlDagNode, layer_number: int) -> int
Set the layer ID on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer_number

The layer number to be assigned to the AlDagNode

type layer_number

int

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer number is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)

set_local_rotation_angles(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Setting the local rotation angles is the only means by which the local rotations axes can be modified.

set_local_rotation_axes(self: alias_api.AlDagNode, arg0: List[float[3]], arg1: List[float[3]], arg2: List[float[3]]) → int: Set the local rotation axes of this dag node to the given world space vectors.

set_rotate_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the rotate pivot and return the status code result of the operation.

set_rotation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the amount of rotation (in degress) about the x, y, z axes. The rotation will be done after the scale transformation and before the final local translation.

set_scale(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the local scale vector. The scale transformation will be done before the local rotations. There is no restriction on the values of the components of the scale vector.

set_scale_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the scale pivot and return the status code result of the operation.

set_surface_orientation(self: alias_api.AlDagNode, flag: int) → int: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

set_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final local translation vector. The translation transformation will be done after rotations.

set_world_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final world translation vector.

translation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the final local translation vector.

type(self: alias_api.AlFaceNode) → alias_api.AlObjectType: Return the AlFaceNode type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

update_draw_info(self: alias_api.AlDagNode) → int: Force the internal draw information to be updated to match the dag node’s geometry.

version(self: alias_api.AlDagNode) → int: Return the version of the dag node.

AlGroupNode

class alias_api.AlGroupNode

add_child_node(self: alias_api.AlGroupNode, child_node: alias_api.AlDagNode) → int

Adds an AlDagNode to the end of the list of child AlDagNodes. If the AlDagNode is already a child of this object, then nothing is done. Otherwise, the AlDagNode is removed from the list of siblings it belongs to and added to the end of this object’s list of children. If the AlDagNode is an AlGroupNode and it has siblings which are instanced AlGroupNodes, those instanced siblings are also made children of this object. It is illegal for the AlDagNode argument to be NULL or for it to not have had its create() method called.

Parameters: child (AlDagNode) – the AlDagNode to be made a child of this object
Returns: The status code result sSuccess - the argument is now a child of this object sInvalidArgument - ‘child’ was not valid sFailure - the AlDagNode could not be made a child of this object sInvalidObject - the groupnode was invalid
Return type: int(AlStatusCode)

add_joint(self: alias_api.AlDagNode) → int: Add an AlJoint to this dag node to maintain IK information.

add_sibling_node(self: alias_api.AlDagNode, sibling: alias_api.AlDagNode) → int: Insert an AlDagNode as the next sibling of this AlDagNode object.

affected_transformation_matrix(*args, **kwargs)

Overloaded function.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM, matrix: alias_api.AlTM) -> int

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM) -> Tuple[int, List[List[float[4]][4]]]

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

apply_iterator_to_children(self: alias_api.AlGroupNode, arg0: AlIterator, arg1: int) → int: Apply the iterator to each of the children in this AlGroupNode.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

bounding_box(self: alias_api.AlDagNode) → Tuple[int, List[List[float[4]][8]]]: Returns the eight corners of the bounding box in world space.

child_node(*args, **kwargs)

Overloaded function.

child_node(self: alias_api.AlGroupNode) -> alias_api.AlDagNode

Return the first AlDagNode in the list of child AlDagNodes.

child_node(self: alias_api.AlGroupNode, arg0: alias_api.AlTM) -> alias_api.AlDagNode

Return the first AlDagNode in the list of child AlDagNodes. The AlTM will be updated with the group node’s transform matrix.

comment(self: alias_api.AlDagNode) → Tuple[int, int, str]: Obtain the size and address of a block of textual data associated with the object.

copy_object(*args, **kwargs)

Overloaded function.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions = None) -> alias_api.AlDagNode

Copy this AlDagNode returning a pointer to the new copy.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions, num_of_blind_data_ids_to_copy: int, blind_data_ids_to_copy: int) -> alias_api.AlDagNode

Return an exact duplicate of this AlDagNode wrapper.

copy_transform(self: alias_api.AlDagNode, node: alias_api.AlDagNode) → int: Copy the local transformation from the given node on to this node.

copy_wrapper(self: alias_api.AlGroupNode) → alias_api.AlObject: Return an exact duplicate of this AlGroupNode wrapper.

create(self: alias_api.AlGroupNode) → int: Initialize the AlGroupNode in the Alias Universe.

create_symmetric_geometry(self: alias_api.AlDagNode) → int: Create the symmetric geometry for this node if it is on a symmetric plane.

delete_object(self: alias_api.AlDagNode) → int: Delete the AlDagNode from the Alias Universe and return the status of the performed operation.

do_updates(self: alias_api.AlDagNode, new_state: int = 1) → int: The doUpdate flag is used to notify the system that you are finished performing. If this flag is True, then it is equivalent to sending out a ‘geometry modified’ message to the rest of the system.

get_surface_orientation(self: alias_api.AlDagNode) → Tuple[int, int]: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

global_transformation_matrix(*args, **kwargs)

Overloaded function.

global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the global transformation matrix for the object.

global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the global transformation matrix for the object.

inverse_global_transformation_matrix(*args, **kwargs)

Overloaded function.

inverse_global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the inverse global transformation matrix for the object.

inverse_global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the inverse global transformation matrix for the object.

is_a_construction_plane(self: alias_api.AlDagNode) → int: Return True if the dag node is a construction plane.

is_ancestor_an_instance(self: alias_api.AlDagNode) → int: Returns True if this AlDagNode or one of its ancestors is an instance node, else False.

is_display_mode_set(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType) → int: Return true if the specified display mode is set (on), else false.

is_instance_node(self: alias_api.AlGroupNode) → int: Return True if this object shares its list of children with another sibling AlGroupNode.

is_instanceable(self: alias_api.AlGroupNode) → int: Return False if this group node contains a non-instanceable dag node, else True.

is_instanced(self: alias_api.AlDagNode) → int: Return True if this is an instance node.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

layer(self: alias_api.AlDagNode) → alias_api.AlLayer: Returns layer the node is assigned.

local_rotate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node rotation based on the setting of the local axes.

local_rotation_angles(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: These angles allow you to determine how the local rotation axis have been rotated from their initial position.

local_rotation_axes(self: alias_api.AlDagNode) → Tuple[int, List[float[3]], List[float[3]], List[float[3]]]: Return the vectors representing the local rotation axes for this node. These axes are the three axes vectors in the world space co-ordinates.

local_transformation_matrix(*args, **kwargs)

Overloaded function.

local_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the local transformation matrix for the object.

local_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the local transformation matrix for the object.

local_translate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node translation based on the setting of the local axes.

property name: Get or set the AlDagNode name.

next_instance(self: alias_api.AlGroupNode) → alias_api.AlGroupNode: Return a pointer to the object’s next sibling node in the list which is an instanced group node.

next_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s next sibling AlDagNode or None if there is no next sibling.

parent_node(self: alias_api.AlDagNode) → AlGroupNode: Returns the parent group node.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_instance(self: alias_api.AlGroupNode) → alias_api.AlGroupNode: Return a pointer to the object’s previous sibling node in the list which is an instanced group node.

prev_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s previous sibling AlDagNode or None if there is no next sibling.

remove_blind_data(self: alias_api.AlDagNode, user_type: int) → int: Remove the block of data of the given type from the object.

remove_comment(self: alias_api.AlDagNode) → int: Remove the block of text associated with this object from the object itself.

remove_joint(self: alias_api.AlDagNode) → int: Remove the AlJoint to this dag node to maintain IK information.

rotate_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the rotation pivot position in world space.

rotation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of rotation (in degrees) about the x, y, and z axes.

scale(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of scale in the x, y, and z direction.

scale_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the scale pivot position in world space.

search_across(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search across the DAG tree (starting at the current node), for a dag node with a specific ‘name’.

search_below(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search the DAG tree (rooted at the child of the current node), for a dag node with a specific ‘name’.

send_geometry_modified_message(self: alias_api.AlDagNode) → int: Send out an update message notifying that the geometry of this dag node has been modified.

set_blind_data(self: alias_api.AlDagNode, user_type: int, size: int, data: str) → int: Associates a block of ‘data’ with the object.

set_comment(self: alias_api.AlDagNode, size: int, data: str) → int: Associates a block of textual ‘data’ with the object.

set_display_mode(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType, on: int) → int: Set the display mode (by name) for this dag node.

set_layer(*args, **kwargs)

Overloaded function.

set_layer(self: alias_api.AlDagNode, layer: alias_api.AlLayer) -> int
Set the layer on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer

The layer object to be assigned to the AlDagNode

type layer

AlLayer

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)
set_layer(self: alias_api.AlDagNode, layer_number: int) -> int
Set the layer ID on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer_number

The layer number to be assigned to the AlDagNode

type layer_number

int

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer number is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)

set_local_rotation_angles(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Setting the local rotation angles is the only means by which the local rotations axes can be modified.

set_local_rotation_axes(self: alias_api.AlDagNode, arg0: List[float[3]], arg1: List[float[3]], arg2: List[float[3]]) → int: Set the local rotation axes of this dag node to the given world space vectors.

set_rotate_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the rotate pivot and return the status code result of the operation.

set_rotation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the amount of rotation (in degress) about the x, y, z axes. The rotation will be done after the scale transformation and before the final local translation.

set_scale(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the local scale vector. The scale transformation will be done before the local rotations. There is no restriction on the values of the components of the scale vector.

set_scale_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the scale pivot and return the status code result of the operation.

set_surface_orientation(self: alias_api.AlDagNode, flag: int) → int: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

set_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final local translation vector. The translation transformation will be done after rotations.

set_world_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final world translation vector.

translation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the final local translation vector.

type(self: alias_api.AlGroupNode) → alias_api.AlObjectType: Return the AlGroupNode type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

update_draw_info(self: alias_api.AlDagNode) → int: Force the internal draw information to be updated to match the dag node’s geometry.

version(self: alias_api.AlDagNode) → int: Return the version of the dag node.

AlHashable

class alias_api.AlHashable: Bases: alias_api.AlLinkItem

AlIKHandle

class alias_api.AlIKHandle

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlIKHandle) → alias_api.AlObject: Return an exact duplicate of this AlIKHandle wrapper.

delete_object(self: alias_api.AlObject) → int: Delete the object from the Alias Universe.

property name: Get or set the object name.

type(self: alias_api.AlIKHandle) → alias_api.AlObjectType: Return the AlIKHandle type identifier.

AlIterator

class alias_api.AlIterator

Bases: pybind11_builtins.pybind11_object

func(self: alias_api.AlIterator, obj: alias_api.AlObject) → int: Pure virtual function that subclass must override to provide functionality to apply to iterator.

AlLayer

class alias_api.AlLayer

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

assign_child(*args, **kwargs)

Overloaded function.

assign_child(self: alias_api.AlLayer, child_layer_number: int) -> int

Assign an Alias layer as child of the current layer.

If this layer is not a folder layer, the operation will fail to assign the child layer.

param child_layer_number

the ID of the child layer which is to be assigned to the layer

type child_layer_number

int

return

The status code result of the operation.

rype

int(AlStatusCode)
assign_child(self: alias_api.AlLayer, child_layer: alias_api.AlLayer) -> int

Assign an Alias layer as child of the current layer.

If this layer is not a folder layer, the operation will fail to assign the child layer.

param child_layer

the child layer to assign to the layer

type child_layer

AlLayer

return

The status code result of the operation.

rype

int(AlStatusCode)

assign_parent(self: alias_api.AlLayer, layer_id: int) → int

Assign an Alias layer as the parent of the current layer.

Parameters: layer_id (int) – the parent layer id to assign to the layer
Returns: The status code result of the operation.
Rype: int(AlStatusCode)

assign_selection(self: alias_api.AlLayer) → int: Assign the current selection to the Alias layer.

assign_sibling_on_left(self: alias_api.AlLayer, layer_id: int) → int

Assign an Alias layer as the sibling on the left of the current layer.

Parameters: layer_id (int) – the sibling layer id to assign to the layer
Returns: The status code result of the operation.
Rype: int(AlStatusCode)

assign_sibling_on_right(self: alias_api.AlLayer, layer_id: int) → int

Assign an Alias layer as the sibling on the right of the current layer.

Parameters: layer_id (int) – the sibling layer id to assign to the layer
Returns: The status code result of the operation.
Rype: int(AlStatusCode)

child_layer(self: alias_api.AlLayer) → alias_api.AlLayer: Return the child layer below this layer in the graph of Alias AlLayer objects.

copy_wrapper(self: alias_api.AlLayer) → alias_api.AlObject: Return an exact duplicate of this AlLayer wrapper.

create(*args, **kwargs)

Overloaded function.

create(self: alias_api.AlLayer, name: str) -> int

Create a new layer.

param name

The name of the new layer.

type name

str

return

The status code result Success - the layer was created Failure - the layer was not created because either the maximum number of layers were already created

or the layer functionality is turned off.

AlreadyCreated - object has already been created

rtype

int(AlStatusCode)
create(self: alias_api.AlLayer, number: int) -> int

Create a new layer with the given number.

param number

The number of the new layer.

type number

int

return

A tuple (status, number) where status - the status code result of the operation

Success - the layer was created Failure - the layer was not created because either the maximum number of layers were already created

or the layer functionality is turned off.

AlreadyCreated - object has already been created

number - the Id of the created layer

rtype

tuple

create_folder(self: alias_api.AlLayer, name: str) → int

Create a new layer folder.

Parameters

name (str) – The name of the new layer folder.

Returns

The status code result Success - the layer folder was created Failure - the layer folder was not created because either the maximum number of layers were already created

or the layer functionality is turned off.

AlreadyCreated - object has already been created

Return type

delete_object(self: alias_api.AlLayer) → int: Delete the layer in the Alias Universe.

property draw_instances: Get or set the draw instances flag on the layer.

export_content_to_file(self: alias_api.AlLayer, path: str) → int: Export the content of the layer to the given file path.

get_assigned_nodes(self: alias_api.AlLayer) → List[AlDagNode]

Return the list of AlDagNodes that are assigned to this AlLayer.

Returns: The list of dag nodes
Return type: list<AlDagNode>

property invisible: Get or set the AlLayer visibility.

is_assigned(self: alias_api.AlLayer, node: AlDagNode) → bool: Return True if the node is assigned to the layer, else False.

is_empty(self: alias_api.AlLayer) → bool: Return True if the Alias layer doesn’t contain any geometry, False otherwise.

is_folder(self: alias_api.AlLayer) → int: Return True if the AlLayer is a layer folder, False otherwise.

is_picked(self: alias_api.AlLayer) → int: Return True if the layer is picked. False is returned if the layer is not picked or if the object is invalid.

property name: Get or set the AlLayer name.

next_layer(self: alias_api.AlLayer) → alias_api.AlLayer: Return the layer following this layer in the graph of Alias AlLayer objects.

property number: Get the AlLayer number.

parent_layer(self: alias_api.AlLayer) → alias_api.AlLayer: Return the parent layer above this layer in the graph of Alias AlLayer objects, None if there is no parent layer.

pick(self: alias_api.AlLayer) → int

Picks the layer.

Returns: The status code result Success - the pick was successfully Failure - the pick operation failed because layers have been disabled InvalidObject - the object is not valid
Return type: int(AlStatusCode)

pick_nodes(self: alias_api.AlLayer) → int: Pick all the nodes assigned to the Alias layer.

prev_layer(self: alias_api.AlLayer) → alias_api.AlLayer: Return the layer previous to this layer in the graph of Alias AlLayer objects.

set_symmetric_normal(self: alias_api.AlLayer, x: float, y: float, z: float) → int

Sets the normal of the symmetric plane.

Parameters

x (float) – the x coordinate of the normal of the symmetric plane
y (float) – the y coordinate of the normal of the symmetric plane
z (float) – the z coordinate of the normal of the symmetric plane

Returns

the status code result of the operation Success - the method succeeded Failure - the method failed InvalidObject - the layer is invalid or is not symmetric

Return type

set_symmetric_origin(self: alias_api.AlLayer, x: float, y: float, z: float) → int

Set the location of the origin of the symmetric layer.

Parameters

x (float) – the x coordinate of the symmetric layer’s origin
y (float) – the y coordinate of the symmetric layer’s origin
z (float) – the z coordinate of the symmetric layer’s origin

Returns

the status code result of the operation Success - the method succeeded Failure - the method failed InvalidObject - the layer is invalid or is not symmetric

Return type

property symmetric: Get or set the symmetric flag on the layer.

symmetric_normal(self: alias_api.AlLayer) → Tuple[int, float, float, float]

Return the symmetric normal of the layer.

Returns

A tuple (status, x, y, z) where status - the status code result of the operation

Success - the method succeeded Failure - the method failed InvalidObject - the layer is invalid or is not symmetric

x - the x coordinate of the normal y - the y coordinate of the normal z - the z coordinate of the normal

Return type

tuple

symmetric_origin(self: alias_api.AlLayer) → Tuple[int, float, float, float]

Return the location of the origin of the symmetric layer.

Returns

A tuple (status, x, y, z) where status - the status code result of the operation

Success - the method succeeded Failure - the method failed InvalidObject - the layer is invalid or is not symmetric

x - the x coordinate of the layer’s origin y - the y coordinate of the layer’s origin z - the z coordinate of the layer’s origin

Return type

tuple

type(self: alias_api.AlLayer) → alias_api.AlObjectType: Return the AlLayer type identifier.

unpick(self: alias_api.AlLayer) → int

Unpicks the layer.

Returns: The status code result Success - the unpick was successfully Failure - the unpick operation failed because layers have been disabled InvalidObject - the object is not valid
Return type: int(AlStatusCode)

AlLayeredShader

class alias_api.AlLayeredShader

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlLayeredShader) → alias_api.AlObject: Return an exact duplicate of this AlLayeredShader wrapper.

create(self: alias_api.AlLayeredShader) → int: Initialize and allocate space for the AlLayeredShader and add it to the global list of shaders in the Alias Universe.

delete_object(self: alias_api.AlLayeredShader) → int: Delete the Alias shader object and return the status code of the delete operation.

is_used(self: alias_api.AlLayeredShader) → int: Returns True if the AlLayeredShader object is assigned to a gemoetry node, else False.

property name: Get or set the AlLayeredShader name.

type(self: alias_api.AlLayeredShader) → alias_api.AlObjectType: Return the AlLayeredShader type identifier.

AlLight

class alias_api.AlLight

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlObject) → alias_api.AlObject: Return an exact duplicate of this AlObject wrapper.

delete_object(self: alias_api.AlLight) → int: Delete the AlLight from the Alias Universe and return the status of the performed operation.

first_linked_object(self: alias_api.AlLight) → alias_api.AlObject

Return the first object that is linked to this light.

If there are no objects linked to this light, then Non is returned. Only objects with 3D geometry can be linked to a light. Cameras, lights, curves and CVs cannot be linked to a light. Surfaces and faces can be linked to a light.

Returns: The first linked object.
Return type: AlObject

has_linked_objects(self: alias_api.AlLight) → int: Return True if this light has any objects linked to it, else False.

light_node(self: alias_api.AlLight) → AlLightNode: Return the dag node that represents the light’s position.

look_at_node(self: alias_api.AlLight) → AlLightNode: Return the ‘look at’ node attached to this light.

property name: Get or set the AlLight name.

next_linked_object(self: alias_api.AlLight, obj: alias_api.AlObject) → alias_api.AlObject

Return the object following the given object that is linked to this linked.

None is returned if there is no following object or if the given object was not found in the light list. Only objects with 3D geometry can be linked to a light. Cameras, lights, curves and CVs cannot be linked to a light. Surfaces and faces can be linked to a light.

Parameters: obj – the object whose following linked object is returned.
Returns: The next linked object t othe given object.
Return type: AlObject

type(self: alias_api.AlLight) → alias_api.AlObjectType: Return the AlLight type identifier.

up_node(self: alias_api.AlLight) → AlLightNode: Return the ‘up’ node attached to this light.

AlLightNode

class alias_api.AlLightNode

add_joint(self: alias_api.AlDagNode) → int: Add an AlJoint to this dag node to maintain IK information.

add_sibling_node(self: alias_api.AlDagNode, sibling: alias_api.AlDagNode) → int: Insert an AlDagNode as the next sibling of this AlDagNode object.

affected_transformation_matrix(*args, **kwargs)

Overloaded function.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM, matrix: alias_api.AlTM) -> int

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM) -> Tuple[int, List[List[float[4]][4]]]

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

bounding_box(self: alias_api.AlDagNode) → Tuple[int, List[List[float[4]][8]]]: Returns the eight corners of the bounding box in world space.

comment(self: alias_api.AlDagNode) → Tuple[int, int, str]: Obtain the size and address of a block of textual data associated with the object.

copy_object(*args, **kwargs)

Overloaded function.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions = None) -> alias_api.AlDagNode

Copy this AlDagNode returning a pointer to the new copy.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions, num_of_blind_data_ids_to_copy: int, blind_data_ids_to_copy: int) -> alias_api.AlDagNode

Return an exact duplicate of this AlDagNode wrapper.

copy_transform(self: alias_api.AlDagNode, node: alias_api.AlDagNode) → int: Copy the local transformation from the given node on to this node.

copy_wrapper(self: alias_api.AlLightNode) → alias_api.AlObject: Return an exact duplicate of this AlLightNode wrapper.

create_symmetric_geometry(self: alias_api.AlDagNode) → int: Create the symmetric geometry for this node if it is on a symmetric plane.

delete_object(self: alias_api.AlLightNode) → int: Delete the AlLightNode from the Alias Universe and return the status of the performed operation.

do_updates(self: alias_api.AlDagNode, new_state: int = 1) → int: The doUpdate flag is used to notify the system that you are finished performing. If this flag is True, then it is equivalent to sending out a ‘geometry modified’ message to the rest of the system.

get_surface_orientation(self: alias_api.AlDagNode) → Tuple[int, int]: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

global_transformation_matrix(*args, **kwargs)

Overloaded function.

global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the global transformation matrix for the object.

global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the global transformation matrix for the object.

inverse_global_transformation_matrix(*args, **kwargs)

Overloaded function.

inverse_global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the inverse global transformation matrix for the object.

inverse_global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the inverse global transformation matrix for the object.

is_a_construction_plane(self: alias_api.AlDagNode) → int: Return True if the dag node is a construction plane.

is_ancestor_an_instance(self: alias_api.AlDagNode) → int: Returns True if this AlDagNode or one of its ancestors is an instance node, else False.

is_display_mode_set(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType) → int: Return true if the specified display mode is set (on), else false.

is_instanceable(self: alias_api.AlLightNode) → int: Return False. A light node can not be instanced.

is_instanced(self: alias_api.AlDagNode) → int: Return True if this is an instance node.

is_look_at_node(self: alias_api.AlLightNode) → int: Return True if this node is a ‘look at’ node.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

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.

layer(self: alias_api.AlDagNode) → alias_api.AlLayer: Returns layer the node is assigned.

light(*args, **kwargs)

Overloaded function.

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.

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

local_rotate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node rotation based on the setting of the local axes.

local_rotation_angles(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: These angles allow you to determine how the local rotation axis have been rotated from their initial position.

local_rotation_axes(self: alias_api.AlDagNode) → Tuple[int, List[float[3]], List[float[3]], List[float[3]]]: Return the vectors representing the local rotation axes for this node. These axes are the three axes vectors in the world space co-ordinates.

local_transformation_matrix(*args, **kwargs)

Overloaded function.

local_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the local transformation matrix for the object.

local_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the local transformation matrix for the object.

local_translate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node translation based on the setting of the local axes.

property name: Get or set the AlDagNode name.

next_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s next sibling AlDagNode or None if there is no next sibling.

parent_node(self: alias_api.AlDagNode) → AlGroupNode: Returns the parent group node.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s previous sibling AlDagNode or None if there is no next sibling.

remove_blind_data(self: alias_api.AlDagNode, user_type: int) → int: Remove the block of data of the given type from the object.

remove_comment(self: alias_api.AlDagNode) → int: Remove the block of text associated with this object from the object itself.

remove_joint(self: alias_api.AlDagNode) → int: Remove the AlJoint to this dag node to maintain IK information.

rotate_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the rotation pivot position in world space.

rotation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of rotation (in degrees) about the x, y, and z axes.

scale(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of scale in the x, y, and z direction.

scale_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the scale pivot position in world space.

search_across(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search across the DAG tree (starting at the current node), for a dag node with a specific ‘name’.

search_below(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search the DAG tree (rooted at the child of the current node), for a dag node with a specific ‘name’.

send_geometry_modified_message(self: alias_api.AlDagNode) → int: Send out an update message notifying that the geometry of this dag node has been modified.

set_blind_data(self: alias_api.AlDagNode, user_type: int, size: int, data: str) → int: Associates a block of ‘data’ with the object.

set_comment(self: alias_api.AlDagNode, size: int, data: str) → int: Associates a block of textual ‘data’ with the object.

set_display_mode(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType, on: int) → int: Set the display mode (by name) for this dag node.

set_layer(*args, **kwargs)

Overloaded function.

set_layer(self: alias_api.AlDagNode, layer: alias_api.AlLayer) -> int
Set the layer on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer

The layer object to be assigned to the AlDagNode

type layer

AlLayer

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)
set_layer(self: alias_api.AlDagNode, layer_number: int) -> int
Set the layer ID on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer_number

The layer number to be assigned to the AlDagNode

type layer_number

int

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer number is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)

set_local_rotation_angles(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Setting the local rotation angles is the only means by which the local rotations axes can be modified.

set_local_rotation_axes(self: alias_api.AlDagNode, arg0: List[float[3]], arg1: List[float[3]], arg2: List[float[3]]) → int: Set the local rotation axes of this dag node to the given world space vectors.

set_rotate_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the rotate pivot and return the status code result of the operation.

set_rotation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the amount of rotation (in degress) about the x, y, z axes. The rotation will be done after the scale transformation and before the final local translation.

set_scale(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the local scale vector. The scale transformation will be done before the local rotations. There is no restriction on the values of the components of the scale vector.

set_scale_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the scale pivot and return the status code result of the operation.

set_surface_orientation(self: alias_api.AlDagNode, flag: int) → int: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

set_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final local translation vector. The translation transformation will be done after rotations.

set_world_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final world translation vector.

translation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the final local translation vector.

type(self: alias_api.AlLightNode) → alias_api.AlObjectType: Return the AlLightNode type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

update_draw_info(self: alias_api.AlDagNode) → int: Force the internal draw information to be updated to match the dag node’s geometry.

version(self: alias_api.AlDagNode) → int: Return the version of the dag node.

AlLinkItem

class alias_api.AlLinkItem: Bases: pybind11_builtins.pybind11_object

AlLocator

class alias_api.AlLocator

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlLocator) → alias_api.AlObject: Return an exact duplicate of this AlLocator wrapper.

delete_object(self: alias_api.AlLocator) → int: Delete the AlLocator from the Alias Universe and return the status of the performed operation.

property invisible: Get or set the AlLocator invisibility property.

is_picked(self: alias_api.AlLocator) → int: On successfully checking the locator, return 1 if the AlLocator is picked, else return 0. On failure to check, return -1.

property layer: Get or set the AlLocator layer object property.

property name: Get or set the AlLocator name property.

pick(self: alias_api.AlLocator) → int: Pick the locator. This function has not effect if the locator is already picked.

templated(self: alias_api.AlLocator) → int: On successfully checking the locator, return 1 if the AlLocator depends on anoather object which is templated, else return 0. On failure to check, return -1.

type(self: alias_api.AlLocator) → alias_api.AlObjectType: Return the AlLocator type identifier.

unpick(self: alias_api.AlLocator) → int: Unpick the locator. This function has not effect if the locator is already picked.

AlMesh

class alias_api.AlMesh

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

assign_layered_shader(self: alias_api.AlMesh, shader: AlLayeredShader) → int

Assigns shader to the mesh.

Parameters: shader (AlShader) – the shader to assign
Returns: The status code result Success - The shader was successfully assigned to the mesh. InvalidArgument - shader is invalid. InvalidObject - The mesh was not created properly. Failure - Unable to process request.

assign_shader(self: alias_api.AlMesh, shader: AlShader) → int

Assigns shader to the mesh.

Parameters: shader (AlShader) – the shader to assign
Returns: The status code result Success - The shader was successfully assigned to the mesh. InvalidArgument - shader is invalid. InvalidObject - The mesh was not created properly. Failure - Unable to process request.

assign_switch_shader(self: alias_api.AlMesh, shader: AlSwitchShader) → int

Assigns shader to the mesh.

Parameters: shader (AlShader) – the shader to assign
Returns: The status code result Success - The shader was successfully assigned to the mesh. InvalidArgument - shader is invalid. InvalidObject - The mesh was not created properly. Failure - Unable to process request.

copy_wrapper(self: alias_api.AlMesh) → alias_api.AlObject: Return an exact duplicate of this AlMesh wrapper.

delete_object(self: alias_api.AlMesh) → int: Delete the AlMesh from the Alias Universe and return the status of the performed operation.

first_shader(self: alias_api.AlMesh) → AlShader: Return the first shader that this mesh object references. The function will return 0 if there are no shaders or the mesh was not created properly.

get_layered_shader(self: alias_api.AlMesh) → AlLayeredShader: Return the layered shader that this mesh object references. The function will return 0 if there are no shaders or the mesh was not created properly.

get_switch_shader(self: alias_api.AlMesh) → AlSwitchShader: Return the switch shader that this mesh object references. The function will return 0 if there are no shaders or the mesh was not created properly.

layer_shader(self: alias_api.AlMesh, shader: AlShader) → int

Layers the shader on the mesh.

Returns: The status code result Success - the shader was successfully layered on the mesh. InvalidArgument - shader is invalid. InvalidObject - The mesh was not created properly. Failure - Unable to process request.

mesh_node(self: alias_api.AlMesh) → AlMeshNode: Return the AlMeshNode for this mesh. Return None if there is not an attached polyset node.

property name: Get or set the AlMesh name.

next_shader(self: alias_api.AlMesh, shader: AlShader) → AlShader

Return the shader after the one specified by shader.

The function will return 0 if:

The end of the shading list has been reached.
The argument, shader, is 0.
the mesh was not created properly.
There are no shaders.”

Parameters: shader (AlShader) – the shader to get the next one from
Returns: The next shader, or 0 if it could not find a next shader.
Return type: AlShader | int

number_of_triangles(self: alias_api.AlMesh) → int: Return the number of triangles currently stored in the mesh. The function will return -1 if the mesh was not created properly.

number_of_vertices(self: alias_api.AlMesh) → int: Return the number of vertices currently stored in the mesh. The function will return -1 if the mesh was not created properly.

type(self: alias_api.AlMesh) → alias_api.AlObjectType: Return the AlMesh type identifier.

AlMeshNode

class alias_api.AlMeshNode

add_joint(self: alias_api.AlDagNode) → int: Add an AlJoint to this dag node to maintain IK information.

add_sibling_node(self: alias_api.AlDagNode, sibling: alias_api.AlDagNode) → int: Insert an AlDagNode as the next sibling of this AlDagNode object.

affected_transformation_matrix(*args, **kwargs)

Overloaded function.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM, matrix: alias_api.AlTM) -> int

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM) -> Tuple[int, List[List[float[4]][4]]]

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

bounding_box(self: alias_api.AlDagNode) → Tuple[int, List[List[float[4]][8]]]: Returns the eight corners of the bounding box in world space.

comment(self: alias_api.AlDagNode) → Tuple[int, int, str]: Obtain the size and address of a block of textual data associated with the object.

copy_object(*args, **kwargs)

Overloaded function.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions = None) -> alias_api.AlDagNode

Copy this AlDagNode returning a pointer to the new copy.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions, num_of_blind_data_ids_to_copy: int, blind_data_ids_to_copy: int) -> alias_api.AlDagNode

Return an exact duplicate of this AlDagNode wrapper.

copy_transform(self: alias_api.AlDagNode, node: alias_api.AlDagNode) → int: Copy the local transformation from the given node on to this node.

copy_wrapper(self: alias_api.AlMeshNode) → alias_api.AlObject: Return an exact duplicate of this AlMeshNode wrapper.

create_symmetric_geometry(self: alias_api.AlDagNode) → int: Create the symmetric geometry for this node if it is on a symmetric plane.

delete_object(self: alias_api.AlDagNode) → int: Delete the AlDagNode from the Alias Universe and return the status of the performed operation.

do_updates(self: alias_api.AlDagNode, new_state: int = 1) → int: The doUpdate flag is used to notify the system that you are finished performing. If this flag is True, then it is equivalent to sending out a ‘geometry modified’ message to the rest of the system.

get_surface_orientation(self: alias_api.AlDagNode) → Tuple[int, int]: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

global_transformation_matrix(*args, **kwargs)

Overloaded function.

global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the global transformation matrix for the object.

global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the global transformation matrix for the object.

inverse_global_transformation_matrix(*args, **kwargs)

Overloaded function.

inverse_global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the inverse global transformation matrix for the object.

inverse_global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the inverse global transformation matrix for the object.

is_a_construction_plane(self: alias_api.AlDagNode) → int: Return True if the dag node is a construction plane.

is_ancestor_an_instance(self: alias_api.AlDagNode) → int: Returns True if this AlDagNode or one of its ancestors is an instance node, else False.

is_display_mode_set(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType) → int: Return true if the specified display mode is set (on), else false.

is_instanceable(self: alias_api.AlDagNode) → int: Return True. An AlDagNode is instanceable by default, unless overridden by derived class.

is_instanced(self: alias_api.AlDagNode) → int: Return True if this is an instance node.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

layer(self: alias_api.AlDagNode) → alias_api.AlLayer: Returns layer the node is assigned.

local_rotate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node rotation based on the setting of the local axes.

local_rotation_angles(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: These angles allow you to determine how the local rotation axis have been rotated from their initial position.

local_rotation_axes(self: alias_api.AlDagNode) → Tuple[int, List[float[3]], List[float[3]], List[float[3]]]: Return the vectors representing the local rotation axes for this node. These axes are the three axes vectors in the world space co-ordinates.

local_transformation_matrix(*args, **kwargs)

Overloaded function.

local_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the local transformation matrix for the object.

local_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the local transformation matrix for the object.

local_translate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node translation based on the setting of the local axes.

mesh(self: alias_api.AlMeshNode) → alias_api.AlMesh: Return a pointer object ot the mesh attached to the node.

property name: Get or set the AlDagNode name.

next_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s next sibling AlDagNode or None if there is no next sibling.

parent_node(self: alias_api.AlDagNode) → AlGroupNode: Returns the parent group node.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s previous sibling AlDagNode or None if there is no next sibling.

remove_blind_data(self: alias_api.AlDagNode, user_type: int) → int: Remove the block of data of the given type from the object.

remove_comment(self: alias_api.AlDagNode) → int: Remove the block of text associated with this object from the object itself.

remove_joint(self: alias_api.AlDagNode) → int: Remove the AlJoint to this dag node to maintain IK information.

rotate_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the rotation pivot position in world space.

rotation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of rotation (in degrees) about the x, y, and z axes.

scale(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of scale in the x, y, and z direction.

scale_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the scale pivot position in world space.

search_across(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search across the DAG tree (starting at the current node), for a dag node with a specific ‘name’.

search_below(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search the DAG tree (rooted at the child of the current node), for a dag node with a specific ‘name’.

send_geometry_modified_message(self: alias_api.AlDagNode) → int: Send out an update message notifying that the geometry of this dag node has been modified.

set_blind_data(self: alias_api.AlDagNode, user_type: int, size: int, data: str) → int: Associates a block of ‘data’ with the object.

set_comment(self: alias_api.AlDagNode, size: int, data: str) → int: Associates a block of textual ‘data’ with the object.

set_display_mode(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType, on: int) → int: Set the display mode (by name) for this dag node.

set_layer(*args, **kwargs)

Overloaded function.

set_layer(self: alias_api.AlDagNode, layer: alias_api.AlLayer) -> int
Set the layer on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer

The layer object to be assigned to the AlDagNode

type layer

AlLayer

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)
set_layer(self: alias_api.AlDagNode, layer_number: int) -> int
Set the layer ID on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer_number

The layer number to be assigned to the AlDagNode

type layer_number

int

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer number is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)

set_local_rotation_angles(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Setting the local rotation angles is the only means by which the local rotations axes can be modified.

set_local_rotation_axes(self: alias_api.AlDagNode, arg0: List[float[3]], arg1: List[float[3]], arg2: List[float[3]]) → int: Set the local rotation axes of this dag node to the given world space vectors.

set_rotate_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the rotate pivot and return the status code result of the operation.

set_rotation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the amount of rotation (in degress) about the x, y, z axes. The rotation will be done after the scale transformation and before the final local translation.

set_scale(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the local scale vector. The scale transformation will be done before the local rotations. There is no restriction on the values of the components of the scale vector.

set_scale_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the scale pivot and return the status code result of the operation.

set_surface_orientation(self: alias_api.AlDagNode, flag: int) → int: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

set_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final local translation vector. The translation transformation will be done after rotations.

set_world_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final world translation vector.

translation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the final local translation vector.

type(self: alias_api.AlMeshNode) → alias_api.AlObjectType: Return the AlMeshNode type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

update_draw_info(self: alias_api.AlDagNode) → int: Force the internal draw information to be updated to match the dag node’s geometry.

version(self: alias_api.AlDagNode) → int: Return the version of the dag node.

AlObject

class alias_api.AlObject

Bases: alias_api.AlHashable

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlObject) → alias_api.AlObject: Return an exact duplicate of this AlObject wrapper.

delete_object(self: alias_api.AlObject) → int: Delete the object from the Alias Universe.

property name: Get or set the object name.

type(self: alias_api.AlObject) → alias_api.AlObjectType: Return the AlObject type identifier.

AlOrthographicCamera

class alias_api.AlOrthographicCamera

Bases: alias_api.AlCamera

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlOrthographicCamera) → alias_api.AlObject: Return an exact duplicate of this AlOrthographicCamera wrapper.

create(self: alias_api.AlOrthographicCamera, view_type: AlWindow::AlViewType) → int: Creates AlOrthographicCamera with the associated window.

delete_object(self: alias_api.AlOrthographicCamera) → int: Delete the AlOrthographicCamera from the Alias Universe.

property name: Get or set the AlOrthographicCamera name.

type(self: alias_api.AlOrthographicCamera) → alias_api.AlObjectType: Return the AlOrthographicCamera type identifier.

AlPerspectiveCamera

class alias_api.AlPerspectiveCamera

Bases: alias_api.AlCamera, alias_api.AlPickable

property angle_of_view: Get or set the angle of view of the camera.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlPerspectiveCamera) → alias_api.AlObject: Return an exact duplicate of this AlPerspectiveCamera wrapper.

create(self: alias_api.AlPerspectiveCamera) → int: Creates a camera and all associated eye, view, and up camera nodes and attaches them to the camera.

delete_object(self: alias_api.AlPerspectiveCamera) → int: Delete the AlPerspectiveCamera from the Alias Universe.

eye(self: alias_api.AlPerspectiveCamera) → AlCameraNode: Return the eye node object attached to the camera.

property focus_length: Get or set the focus length of the camera.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

property name: Get or set the AlPerspectiveCamera name.

pick(self: alias_api.AlPickable) → int: Pick the object

set_world_eye(*args, **kwargs)

Overloaded function.

set_world_eye(self: alias_api.AlPerspectiveCamera, p: alPyMath::Vec3) -> int

Set the world eye position and return the status code result of the operation.

set_world_eye(self: alias_api.AlPerspectiveCamera, x: float, y: float, z: float) -> int

Sets the camera’s world eye position to be x,y, & z in world space. The value will be set in the camera’s eye node.

param x

The new world eye position along the x axis.

type x

float

param y

The new world eye position along the y axis.

type y

float

param z

The new world eye position along the z axis.

type z

float

return

The status code result: Success - the position was successfully set InvalidObject - the camera is not valid.

rtype

int(StatusCode)

set_world_up(*args, **kwargs)

Overloaded function.

set_world_up(self: alias_api.AlPerspectiveCamera, p: alPyMath::Vec3) -> int

Set the world up position and return the status code result of the operation.

param p

A vec3 containing the new world up position.

return

The status code result: Success - the position was successfully set InvalidObject - the camera is not valid.

rtype

int(StatusCode)
set_world_up(self: alias_api.AlPerspectiveCamera, x: float, y: float, z: float) -> int

Sets the camera’s world up position to be x,y, & z in world space. The value will be set in the camera’s up node.

param x

The new world up position along the x axis.

type x

float

param y

The new world up position along the y axis.

type y

float

param z

The new world up position along the z axis.

type z

float

return

The status code result: Success - the position was successfully set InvalidObject - the camera is not valid.

rtype

int(StatusCode)

set_world_view(*args, **kwargs)

Overloaded function.

set_world_view(self: alias_api.AlPerspectiveCamera, p: alPyMath::Vec3) -> int

Set the world view position and return the status code result of the operation.

set_world_view(self: alias_api.AlPerspectiveCamera, x: float, y: float, z: float) -> int

Sets the camera’s world view position to be x,y, & z in world space. The value will be set in the camera’s view node.

param x

The new world view position along the x axis.

type x

float

param y

The new world view position along the y axis.

type y

float

param z

The new world view position along the z axis.

type z

float

return

The status code result: Success - the position was successfully set InvalidObject - the camera is not valid.

rtype

int(StatusCode)

type(self: alias_api.AlPerspectiveCamera) → alias_api.AlObjectType: Return the AlPerspectiveCamera type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

up(self: alias_api.AlPerspectiveCamera) → AlCameraNode: Return the up node object attached to the camera.

view(self: alias_api.AlPerspectiveCamera) → AlCameraNode: Return the view node object attached to the camera.

world_eye(self: alias_api.AlPerspectiveCamera) → Tuple[int, float, float, float]

Find the world coordinates of the camera’s eye location.

Returns

A tuple (status, x, y, z), where status [AlStatusCode] - the status code result

Success - the coordinates was found InvalidObject - the point is not valid

x [float] - the x world coordinate of the eye position y [float] - the y world coordinate of the eye position z [float] - the z world coordinate of the eye position

Return type

tuple

world_up(self: alias_api.AlPerspectiveCamera) → Tuple[int, float, float, float]

Find the world coordinates of the camera’s up location.

Returns

A tuple (status, x, y, z), where status [AlStatusCode] - the status code result

Success - the coordinates was found InvalidObject - the point is not valid

x [float] - the x world coordinate of the up position y [float] - the y world coordinate of the up position z [float] - the z world coordinate of the up position

Return type

tuple

world_view(self: alias_api.AlPerspectiveCamera) → Tuple[int, float, float, float]

Find the world coordinates of the camera’s view location.

Returns

A tuple (status, x, y, z), where status [AlStatusCode] - the status code result

Success - the coordinates was found InvalidObject - the point is not valid

x [float] - the x world coordinate of the view position y [float] - the y world coordinate of the view position z [float] - the z world coordinate of the view position

Return type

tuple

AlPickable

class alias_api.AlPickable

Bases: pybind11_builtins.pybind11_object

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

pick(self: alias_api.AlPickable) → int: Pick the object

unpick(self: alias_api.AlPickable) → int: Unpick the object

AlPoint

class alias_api.AlPoint

Bases: alias_api.AlConstructionEntity

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlPoint) → alias_api.AlObject: Return an exact duplicate of this AlPoint wrapper.

delete_object(self: alias_api.AlConstructionEntity) → int: Delete the AlConstructionEntity from the Alias Universe and return the status of the performed operation.

property invisible: Get or set the AlConstructionEntity invisibility.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

property layer: Get or set the AlConstructionEntity layer.

property name: Get or set the AlConstructionEntity name.

pick(self: alias_api.AlPickable) → int: Pick the object

templated(self: alias_api.AlConstructionEntity) → int: On successfully checking the entity, return 1 if the AlConstructionEntity depends on anoather object which is templated, else return 0. On failure to check, return -1.

type(self: alias_api.AlPoint) → alias_api.AlObjectType: Return the AlPoint type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

worldPosition(self: alias_api.AlPoint, x: float, y: float, z: float) → int: Return the world coordinates of the AlPoint.

AlReferenceFile

class alias_api.AlReferenceFile

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlReferenceFile) → alias_api.AlObject: Return an exact duplicate of this AlReferenceFile wrapper.

delete_object(self: alias_api.AlReferenceFile) → int: Delete the AlReferenceFile from the Alias Universe and return the status of the performed operation.

property file_name: Get the AlReferenceFile file name.

get_alternatives(self: alias_api.AlReferenceFile) → List[AlReferenceFileSet]: Return a list of all the alternatives this AlReferenceFile belongs to.

property name: Get the AlReferenceFile name.

property path: Deprecated - use ‘file_name’ property instead.

property source_path: Deprecated - use ‘source_wirefile’ property instead.

property source_wirefile: Get the AlReferenceFile source wire file path.

type(self: alias_api.AlReferenceFile) → alias_api.AlObjectType: Return the AlReferenceFile type identifier.

property uuid: Get the AlReferenceFile UUID.

AlReferenceFileSet

class alias_api.AlReferenceFileSet

add_reference(self: alias_api.AlReferenceFileSet, ref_file: alias_api.AlReferenceFile) → int: Deprecated - use ‘add_reference_file_to_alternative’ instead.

add_reference_file_to_alternative(self: alias_api.AlReferenceFileSet, ref_file: alias_api.AlReferenceFile) → int: Add an AlReferenceFile to the AlReferenceFileSet.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlReferenceFileSet) → alias_api.AlObject: Return an exact duplicate of this AlReferenceFileSet wrapper.

delete_object(self: alias_api.AlReferenceFileSet) → int: Delete the AlReferenceFileSet from the Alias Universe and return the status of the performed operation.

get_references(self: alias_api.AlReferenceFileSet) → List[alias_api.AlReferenceFile]: Return a list of all the AlReferenceFiles for this AlReferenceFileSet.

property name: Get or set the AlReferenceFile name.

type(self: alias_api.AlReferenceFileSet) → alias_api.AlObjectType: Return the AlReferenceFileSet type identifier.

AlShader

class alias_api.AlShader

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_object(self: alias_api.AlShader) → alias_api.AlShader: Copy this AlShader object and return the new object, or None if the copy operation failed.

copy_wrapper(self: alias_api.AlShader) → alias_api.AlObject: Return an exact duplicate of this AlShader wrapper.

create(self: alias_api.AlShader) → int: Initialize and allocate space for the AlShader and add it to the global list of shaders in the Alias Universe.

delete_object(self: alias_api.AlShader, force: bool = False) → int: Delete the AlObject from the Alias Universe and return the status of the performed operation.

get_assigned_nodes(self: alias_api.AlShader) → List[alias_api.AlDagNode]

Return the list of AlDagNodes that are assigned to this AlShader.

Returns: The list of dag nodes
Return type: list<AlDagNode>

is_assigned(self: alias_api.AlShader, node: alias_api.AlDagNode) → bool: Return True if the node is assigned to the shader, else False.

is_used(self: alias_api.AlShader) → int: Return True if the AlShader is being used by another object.

property name: Get or set the unique identifying name property.

property shading_model: Get or set the shading model property.

type(self: alias_api.AlShader) → alias_api.AlObjectType: Return the shader type identifier.

AlShell

class alias_api.AlShell

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

assign_shader(self: alias_api.AlShell, shader: AlShader) → int

Assign the given shader to the surface.

If the surface already has shaders they will be removed from the surface. The surface must have a surface node for this method to succeed.

Parameters: shader (AlShader) – the shader which will be assigned to the surface.
Returns: The status code result Success - the shader was successfully assigned to the surface. InvalidArgument - ‘shader’ was invalid Failure - the shader was not created. InvalidObject - the surface is invalid
Return type: int(AlStatusCode)

copy_wrapper(self: alias_api.AlShell) → alias_api.AlObject: Return an exact duplicate of this AlShell wrapper.

delete_object(self: alias_api.AlObject) → int: Delete the object from the Alias Universe.

first_shader(self: alias_api.AlShell) → AlShader: Return the first shader that this surface object references. Return None if there are no shaders.

get_layered_shader(self: alias_api.AlShell) → AlLayeredShader: Return the attached layered shader.

get_switch_shader(self: alias_api.AlShell) → AlSwitchShader: Return the attached switch shader.

layer_shader(self: alias_api.AlShell, shader: AlShader) → int

Layers the given shader on the surface.

The surface must have a surface node for this method to succeed.

Parameters: shader – the shader which will be layered on the surface.
Tye shader: AlShader
Returns: The status code result Success - the shader was successfully layered on the surface. InvalidArgument - ‘shader’ was invalid Failure - the shader was not created. InvalidObject - the surface is invalid
Return type: int(AlStatusCode)

property name: Get or set the object name.

next_shader(self: alias_api.AlShell, shader: AlShader) → AlShader

Return the shader after the given shader in the object’s shader list.

Return None if there isn’t a next shader. Specifying None as parameter will return the first shader.

Parameters: shader (AlShader) – the shader to get the next one from
Returns: The next shader
Return type: AlShader

shell_node(self: alias_api.AlShell) → AlShellNode: Return the AlShellNode for this surface.

type(self: alias_api.AlShell) → alias_api.AlObjectType: Return the AlShell type identifier.

AlShellNode

class alias_api.AlShellNode

add_joint(self: alias_api.AlDagNode) → int: Add an AlJoint to this dag node to maintain IK information.

add_sibling_node(self: alias_api.AlDagNode, sibling: alias_api.AlDagNode) → int: Insert an AlDagNode as the next sibling of this AlDagNode object.

affected_transformation_matrix(*args, **kwargs)

Overloaded function.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM, matrix: alias_api.AlTM) -> int

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM) -> Tuple[int, List[List[float[4]][4]]]

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

bounding_box(self: alias_api.AlDagNode) → Tuple[int, List[List[float[4]][8]]]: Returns the eight corners of the bounding box in world space.

comment(self: alias_api.AlDagNode) → Tuple[int, int, str]: Obtain the size and address of a block of textual data associated with the object.

copy_object(*args, **kwargs)

Overloaded function.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions = None) -> alias_api.AlDagNode

Copy this AlDagNode returning a pointer to the new copy.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions, num_of_blind_data_ids_to_copy: int, blind_data_ids_to_copy: int) -> alias_api.AlDagNode

Return an exact duplicate of this AlDagNode wrapper.

copy_transform(self: alias_api.AlDagNode, node: alias_api.AlDagNode) → int: Copy the local transformation from the given node on to this node.

copy_wrapper(self: alias_api.AlShellNode) → alias_api.AlObject: Return an exact duplicate of this AlShellNode wrapper.

create_symmetric_geometry(self: alias_api.AlDagNode) → int: Create the symmetric geometry for this node if it is on a symmetric plane.

delete_object(self: alias_api.AlDagNode) → int: Delete the AlDagNode from the Alias Universe and return the status of the performed operation.

do_updates(self: alias_api.AlDagNode, new_state: int = 1) → int: The doUpdate flag is used to notify the system that you are finished performing. If this flag is True, then it is equivalent to sending out a ‘geometry modified’ message to the rest of the system.

get_surface_orientation(self: alias_api.AlDagNode) → Tuple[int, int]: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

global_transformation_matrix(*args, **kwargs)

Overloaded function.

global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the global transformation matrix for the object.

global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the global transformation matrix for the object.

inverse_global_transformation_matrix(*args, **kwargs)

Overloaded function.

inverse_global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the inverse global transformation matrix for the object.

inverse_global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the inverse global transformation matrix for the object.

is_a_construction_plane(self: alias_api.AlDagNode) → int: Return True if the dag node is a construction plane.

is_ancestor_an_instance(self: alias_api.AlDagNode) → int: Returns True if this AlDagNode or one of its ancestors is an instance node, else False.

is_display_mode_set(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType) → int: Return true if the specified display mode is set (on), else false.

is_instanceable(self: alias_api.AlDagNode) → int: Return True. An AlDagNode is instanceable by default, unless overridden by derived class.

is_instanced(self: alias_api.AlDagNode) → int: Return True if this is an instance node.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

layer(self: alias_api.AlDagNode) → alias_api.AlLayer: Returns layer the node is assigned.

local_rotate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node rotation based on the setting of the local axes.

local_rotation_angles(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: These angles allow you to determine how the local rotation axis have been rotated from their initial position.

local_rotation_axes(self: alias_api.AlDagNode) → Tuple[int, List[float[3]], List[float[3]], List[float[3]]]: Return the vectors representing the local rotation axes for this node. These axes are the three axes vectors in the world space co-ordinates.

local_transformation_matrix(*args, **kwargs)

Overloaded function.

local_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the local transformation matrix for the object.

local_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the local transformation matrix for the object.

local_translate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node translation based on the setting of the local axes.

property name: Get or set the AlDagNode name.

next_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s next sibling AlDagNode or None if there is no next sibling.

parent_node(self: alias_api.AlDagNode) → AlGroupNode: Returns the parent group node.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s previous sibling AlDagNode or None if there is no next sibling.

remove_blind_data(self: alias_api.AlDagNode, user_type: int) → int: Remove the block of data of the given type from the object.

remove_comment(self: alias_api.AlDagNode) → int: Remove the block of text associated with this object from the object itself.

remove_joint(self: alias_api.AlDagNode) → int: Remove the AlJoint to this dag node to maintain IK information.

rotate_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the rotation pivot position in world space.

rotation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of rotation (in degrees) about the x, y, and z axes.

scale(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of scale in the x, y, and z direction.

scale_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the scale pivot position in world space.

search_across(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search across the DAG tree (starting at the current node), for a dag node with a specific ‘name’.

search_below(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search the DAG tree (rooted at the child of the current node), for a dag node with a specific ‘name’.

send_geometry_modified_message(self: alias_api.AlDagNode) → int: Send out an update message notifying that the geometry of this dag node has been modified.

set_blind_data(self: alias_api.AlDagNode, user_type: int, size: int, data: str) → int: Associates a block of ‘data’ with the object.

set_comment(self: alias_api.AlDagNode, size: int, data: str) → int: Associates a block of textual ‘data’ with the object.

set_display_mode(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType, on: int) → int: Set the display mode (by name) for this dag node.

set_layer(*args, **kwargs)

Overloaded function.

set_layer(self: alias_api.AlDagNode, layer: alias_api.AlLayer) -> int
Set the layer on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer

The layer object to be assigned to the AlDagNode

type layer

AlLayer

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)
set_layer(self: alias_api.AlDagNode, layer_number: int) -> int
Set the layer ID on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer_number

The layer number to be assigned to the AlDagNode

type layer_number

int

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer number is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)

set_local_rotation_angles(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Setting the local rotation angles is the only means by which the local rotations axes can be modified.

set_local_rotation_axes(self: alias_api.AlDagNode, arg0: List[float[3]], arg1: List[float[3]], arg2: List[float[3]]) → int: Set the local rotation axes of this dag node to the given world space vectors.

set_rotate_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the rotate pivot and return the status code result of the operation.

set_rotation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the amount of rotation (in degress) about the x, y, z axes. The rotation will be done after the scale transformation and before the final local translation.

set_scale(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the local scale vector. The scale transformation will be done before the local rotations. There is no restriction on the values of the components of the scale vector.

set_scale_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the scale pivot and return the status code result of the operation.

set_surface_orientation(self: alias_api.AlDagNode, flag: int) → int: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

set_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final local translation vector. The translation transformation will be done after rotations.

set_world_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final world translation vector.

shell(*args, **kwargs)

Overloaded function.

shell(self: alias_api.AlShellNode) -> alias_api.AlShell

Return a pointer to the shell data structure which can be used to access the geometry of the shell.

shell(self: alias_api.AlShellNode, arg0: alias_api.AlTM) -> alias_api.AlShell

Return a pointer to the shell data structure which can be used to access the geometry of the shell. The AlTM will be updated with the shell’s transformation matrix.

translation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the final local translation vector.

type(self: alias_api.AlShellNode) → alias_api.AlObjectType: Return the AlShellNode type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

update_draw_info(self: alias_api.AlDagNode) → int: Force the internal draw information to be updated to match the dag node’s geometry.

version(self: alias_api.AlDagNode) → int: Return the version of the dag node.

AlSpacePoint

class alias_api.AlSpacePoint

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlSpacePoint) → alias_api.AlObject: Return an exact duplicate of this AlSpacePoint wrapper.

create(self: alias_api.AlSpacePoint, x: float, y: float, z: float) → int: Create an AlSpacePoint at the given coordinates.

delete_object(self: alias_api.AlConstructionEntity) → int: Delete the AlConstructionEntity from the Alias Universe and return the status of the performed operation.

property invisible: Get or set the AlConstructionEntity invisibility.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

property layer: Get or set the AlConstructionEntity layer.

property name: Get or set the AlConstructionEntity name.

pick(self: alias_api.AlPickable) → int: Pick the object

templated(self: alias_api.AlConstructionEntity) → int: On successfully checking the entity, return 1 if the AlConstructionEntity depends on anoather object which is templated, else return 0. On failure to check, return -1.

type(self: alias_api.AlSpacePoint) → alias_api.AlObjectType: Return the AlSpacePoint type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

worldPosition(self: alias_api.AlPoint, x: float, y: float, z: float) → int: Return the world coordinates of the AlPoint.

AlSurface

class alias_api.AlSurface

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

assign_shader(self: alias_api.AlSurface, shader: AlShader) → int

Assign the given shader to the surface.

If the surface already has shaders they will be removed from the surface. The surface must have a surface node for this method to succeed.

Parameters: shader (AlShader) – the shader which will be assigned to the surface.
Returns: The status code result Success - the shader was successfully assigned to the surface. InvalidArgument - ‘shader’ was invalid Failure - the shader was not created. InvalidObject - the surface is invalid
Return type: int(AlStatusCode)

copy_wrapper(self: alias_api.AlSurface) → alias_api.AlObject: Return an exact duplicate of this AlSurface wrapper.

delete_object(self: alias_api.AlSurface) → int: Delete the AlSurface from the Alias Universe and return the status of the performed operation.

first_shader(self: alias_api.AlSurface) → AlShader: Return the first shader that this surface object references. Return None if there are no shaders.

get_curves_on_surface(self: alias_api.AlSurface) → List[alias_api.AlCurveOnSurface]: Return a list of curve on surface nodes.

get_layered_shader(self: alias_api.AlSurface) → AlLayeredShader: Return the attached layered shader.

get_shaders(self: alias_api.AlSurface) → List[AlShader]: Return a list of shaders.

get_switch_shader(self: alias_api.AlSurface) → AlSwitchShader: Return the attached switch shader.

is_construction_history_resulting_surface(self: alias_api.AlSurface) → int: Returns True if this surface is the resulting surface of a construction history operation, else False.

layer_shader(self: alias_api.AlSurface, shader: AlShader) → int

Layers the given shader on the surface.

The surface must have a surface node for this method to succeed.

Parameters: shader – the shader which will be layered on the surface.
Tye shader: AlShader
Returns: The status code result Success - the shader was successfully layered on the surface. InvalidArgument - ‘shader’ was invalid Failure - the shader was not created. InvalidObject - the surface is invalid
Return type: int(AlStatusCode)

property name: Get or set the AlSurface name.

next_shader(self: alias_api.AlSurface, shader: AlShader) → AlShader

Return the shader after the given shader in the object’s shader list.

Return None if there isn’t a next shader. Specifying None as parameter will return the first shader.

Parameters: shader (AlShader) – the shader to get the next one from
Returns: The next shader
Return type: AlShader

surface_node(self: alias_api.AlSurface) → AlSurfaceNode: Return the surface node for this surface. Return None if there is no surface node attached.

type(self: alias_api.AlSurface) → alias_api.AlObjectType: Return the AlSurface type identifier.

AlSurfaceNode

class alias_api.AlSurfaceNode

add_joint(self: alias_api.AlDagNode) → int: Add an AlJoint to this dag node to maintain IK information.

add_sibling_node(self: alias_api.AlDagNode, sibling: alias_api.AlDagNode) → int: Insert an AlDagNode as the next sibling of this AlDagNode object.

affected_transformation_matrix(*args, **kwargs)

Overloaded function.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM, matrix: alias_api.AlTM) -> int

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM) -> Tuple[int, List[List[float[4]][4]]]

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

bounding_box(self: alias_api.AlDagNode) → Tuple[int, List[List[float[4]][8]]]: Returns the eight corners of the bounding box in world space.

comment(self: alias_api.AlDagNode) → Tuple[int, int, str]: Obtain the size and address of a block of textual data associated with the object.

copy_object(*args, **kwargs)

Overloaded function.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions = None) -> alias_api.AlDagNode

Copy this AlDagNode returning a pointer to the new copy.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions, num_of_blind_data_ids_to_copy: int, blind_data_ids_to_copy: int) -> alias_api.AlDagNode

Return an exact duplicate of this AlDagNode wrapper.

copy_transform(self: alias_api.AlDagNode, node: alias_api.AlDagNode) → int: Copy the local transformation from the given node on to this node.

copy_wrapper(self: alias_api.AlSurfaceNode) → alias_api.AlObject: Return an exact duplicate of this AlSurfaceNode wrapper.

create(self: alias_api.AlSurfaceNode, surface: alias_api.AlSurface) → int

Allocate the dag node and geometry required for this object.

This method must be called once and only once before any other method and only if the surface has been allocated by the user (e.g. not read in from a wire file). It is an error to call this method twice or if the object has been read in from a wire file.

Parameters: surface (AlSurface) – The surface to create this surface node for.
Returns: The status code result Success - the surface node was created InvalidArgument - the ‘surface’ was None or invalid Failure - the surface node was not created
Return type: AlStatusCode

create_symmetric_geometry(self: alias_api.AlDagNode) → int: Create the symmetric geometry for this node if it is on a symmetric plane.

delete_object(self: alias_api.AlSurfaceNode) → int: Delete the AlSurfaceNode from the Alias Universe and return the status of the performed operation.

do_updates(self: alias_api.AlDagNode, new_state: int = 1) → int: The doUpdate flag is used to notify the system that you are finished performing. If this flag is True, then it is equivalent to sending out a ‘geometry modified’ message to the rest of the system.

get_surface_orientation(self: alias_api.AlDagNode) → Tuple[int, int]: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

global_transformation_matrix(*args, **kwargs)

Overloaded function.

global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the global transformation matrix for the object.

global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the global transformation matrix for the object.

has_history(self: alias_api.AlSurfaceNode) → bool: Return True if the surface node’s surface has construction history.

inverse_global_transformation_matrix(*args, **kwargs)

Overloaded function.

inverse_global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the inverse global transformation matrix for the object.

inverse_global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the inverse global transformation matrix for the object.

is_a_construction_plane(self: alias_api.AlDagNode) → int: Return True if the dag node is a construction plane.

is_ancestor_an_instance(self: alias_api.AlDagNode) → int: Returns True if this AlDagNode or one of its ancestors is an instance node, else False.

is_display_mode_set(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType) → int: Return true if the specified display mode is set (on), else false.

is_instanceable(self: alias_api.AlDagNode) → int: Return True. An AlDagNode is instanceable by default, unless overridden by derived class.

is_instanced(self: alias_api.AlDagNode) → int: Return True if this is an instance node.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

layer(self: alias_api.AlDagNode) → alias_api.AlLayer: Returns layer the node is assigned.

local_rotate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node rotation based on the setting of the local axes.

local_rotation_angles(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: These angles allow you to determine how the local rotation axis have been rotated from their initial position.

local_rotation_axes(self: alias_api.AlDagNode) → Tuple[int, List[float[3]], List[float[3]], List[float[3]]]: Return the vectors representing the local rotation axes for this node. These axes are the three axes vectors in the world space co-ordinates.

local_transformation_matrix(*args, **kwargs)

Overloaded function.

local_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the local transformation matrix for the object.

local_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the local transformation matrix for the object.

local_translate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node translation based on the setting of the local axes.

property name: Get or set the AlDagNode name.

next_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s next sibling AlDagNode or None if there is no next sibling.

parent_node(self: alias_api.AlDagNode) → AlGroupNode: Returns the parent group node.

patch_precision(self: alias_api.AlSurfaceNode) → int: Return the patch precision for the surface. Return -1 if the surface is invalid.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s previous sibling AlDagNode or None if there is no next sibling.

remove_blind_data(self: alias_api.AlDagNode, user_type: int) → int: Remove the block of data of the given type from the object.

remove_comment(self: alias_api.AlDagNode) → int: Remove the block of text associated with this object from the object itself.

remove_joint(self: alias_api.AlDagNode) → int: Remove the AlJoint to this dag node to maintain IK information.

rotate_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the rotation pivot position in world space.

rotation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of rotation (in degrees) about the x, y, and z axes.

scale(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of scale in the x, y, and z direction.

scale_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the scale pivot position in world space.

search_across(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search across the DAG tree (starting at the current node), for a dag node with a specific ‘name’.

search_below(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search the DAG tree (rooted at the child of the current node), for a dag node with a specific ‘name’.

send_geometry_modified_message(self: alias_api.AlDagNode) → int: Send out an update message notifying that the geometry of this dag node has been modified.

set_blind_data(self: alias_api.AlDagNode, user_type: int, size: int, data: str) → int: Associates a block of ‘data’ with the object.

set_comment(self: alias_api.AlDagNode, size: int, data: str) → int: Associates a block of textual ‘data’ with the object.

set_display_mode(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType, on: int) → int: Set the display mode (by name) for this dag node.

set_layer(*args, **kwargs)

Overloaded function.

set_layer(self: alias_api.AlDagNode, layer: alias_api.AlLayer) -> int
Set the layer on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer

The layer object to be assigned to the AlDagNode

type layer

AlLayer

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)
set_layer(self: alias_api.AlDagNode, layer_number: int) -> int
Set the layer ID on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer_number

The layer number to be assigned to the AlDagNode

type layer_number

int

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer number is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)

set_local_rotation_angles(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Setting the local rotation angles is the only means by which the local rotations axes can be modified.

set_local_rotation_axes(self: alias_api.AlDagNode, arg0: List[float[3]], arg1: List[float[3]], arg2: List[float[3]]) → int: Set the local rotation axes of this dag node to the given world space vectors.

set_patch_precision(self: alias_api.AlSurfaceNode, precision: int) → int

Set the patch precision for the surface.

Parameters: precision (int) – The new patch precision (range is 2-64).
Returns: The status code result Success - the patch precision was set InvalidArgument - value for patch prevision was invalid InvalidObject - the surface node was invalid
Return type: AlStatusCode

set_rotate_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the rotate pivot and return the status code result of the operation.

set_rotation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the amount of rotation (in degress) about the x, y, z axes. The rotation will be done after the scale transformation and before the final local translation.

set_scale(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the local scale vector. The scale transformation will be done before the local rotations. There is no restriction on the values of the components of the scale vector.

set_scale_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the scale pivot and return the status code result of the operation.

set_surface_orientation(self: alias_api.AlDagNode, flag: int) → int: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

set_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final local translation vector. The translation transformation will be done after rotations.

set_world_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final world translation vector.

surface(*args, **kwargs)

Overloaded function.

surface(self: alias_api.AlSurfaceNode) -> alias_api.AlSurface

Return a the surface data structure which can be used to access the geometry of the surface.

surface(self: alias_api.AlSurfaceNode, arg0: alias_api.AlTM) -> alias_api.AlSurface

Return a the surface data structure which can be used to access the geometry of the surface.

translation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the final local translation vector.

type(self: alias_api.AlSurfaceNode) → alias_api.AlObjectType: Return the AlSurfaceNode type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

update_draw_info(self: alias_api.AlDagNode) → int: Force the internal draw information to be updated to match the dag node’s geometry.

version(self: alias_api.AlDagNode) → int: Return the version of the dag node.

AlSurfacePoint

class alias_api.AlSurfacePoint

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

attached_to(self: alias_api.AlSurfacePoint) → alias_api.AlSurfaceNode: Return the AlSurfaceNode this AlSurfacePoint is associated with.

copy_wrapper(self: alias_api.AlSurfacePoint) → alias_api.AlObject: Return an exact duplicate of this AlSurfacePoint wrapper.

create(self: alias_api.AlSurfacePoint, surface: alias_api.AlSurface, u: float, v: float) → int: Create an AlSurfacePoint on the given AlSurface.

delete_object(self: alias_api.AlConstructionEntity) → int: Delete the AlConstructionEntity from the Alias Universe and return the status of the performed operation.

property invisible: Get or set the AlConstructionEntity invisibility.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

property layer: Get or set the AlConstructionEntity layer.

property name: Get or set the AlConstructionEntity name.

pick(self: alias_api.AlPickable) → int: Pick the object

templated(self: alias_api.AlConstructionEntity) → int: On successfully checking the entity, return 1 if the AlConstructionEntity depends on anoather object which is templated, else return 0. On failure to check, return -1.

type(self: alias_api.AlSurfacePoint) → alias_api.AlObjectType: Return the AlSurfacePoint type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

worldPosition(self: alias_api.AlPoint, x: float, y: float, z: float) → int: Return the world coordinates of the AlPoint.

AlSwitchShader

class alias_api.AlSwitchShader

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

copy_wrapper(self: alias_api.AlSwitchShader) → alias_api.AlObject: Return an exact duplicate of this AlSwitchShader wrapper.

create(self: alias_api.AlSwitchShader) → int: Initialize and allocate space for the AlSwitchShader and add it to the global list of shaders in the Alias Universe.

delete_object(self: alias_api.AlSwitchShader) → int: Delete the Alias shader object and return the status code of the delete operation.

is_used(self: alias_api.AlSwitchShader) → int: Returns True if the SwitchShader object is assigned to a gemoetry node, else False.

property name: Get or set the AlSwitchShader name.

type(self: alias_api.AlSwitchShader) → alias_api.AlObjectType: Return the AlSwitchShader type identifier.

AlTextureNode

class alias_api.AlTextureNode

add_joint(self: alias_api.AlDagNode) → int: Add an AlJoint to this dag node to maintain IK information.

add_sibling_node(self: alias_api.AlDagNode, sibling: alias_api.AlDagNode) → int: Insert an AlDagNode as the next sibling of this AlDagNode object.

affected_transformation_matrix(*args, **kwargs)

Overloaded function.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM, matrix: alias_api.AlTM) -> int

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

affected_transformation_matrix(self: alias_api.AlDagNode, tm: alias_api.AlTM) -> Tuple[int, List[List[float[4]][4]]]

Compute the transformation matrix for the object which is obtained by multiplying the local transformation matrix with the given AlTM ‘tm’.

as_annotation_locator_ptr(*args, **kwargs)

Overloaded function.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the object to it.

as_annotation_locator_ptr(self: alias_api.AlObject) -> AlAnnotationLocator

Return a non-null pointer to an AlAnnotationLocator if it is safe to downcast the obect to it.

as_camera_node_ptr(*args, **kwargs)

Overloaded function.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the object to it.

as_camera_node_ptr(self: alias_api.AlObject) -> AlCameraNode

Return a non-null pointer to an AlCameraNode if it is safe to downcast the obect to it.

as_camera_ptr(self: alias_api.AlObject) → AlCamera: Return a non-null pointer to an AlCamera if it is safe to downcast the object to it.

as_cluster_ptr(self: alias_api.AlObject) → AlCluster: Return a non-null pointer to an AlCluster if it is safe to downcast the object to it.

as_dag_node_ptr(self: alias_api.AlObject) → AlDagNode: Return a non-null pointer to an AlDagNode if it is safe to downcast the object to it.

as_layer_ptr(self: alias_api.AlObject) → AlLayer: Return a non-null pointer to an AlLayer if it is safe to downcast the object to it.

as_layered_shader_ptr(self: alias_api.AlObject) → AlLayeredShader: Return a non-null pointer to a AlLayeredShader if it is safe to downcast the object to it.

as_locator_ptr(*args, **kwargs)

Overloaded function.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the object to it.

as_locator_ptr(self: alias_api.AlObject) -> AlLocator

Return a non-null pointer to an AlLocator if it is safe to downcast the obect to it.

as_mesh_node_ptr(self: alias_api.AlObject) → AlMeshNode: Return a non-null pointer to an AlMeshNode if it is safe to downcast the object to it.

as_mesh_ptr(self: alias_api.AlObject) → AlMesh: Return a non-null pointer to an AlMesh if it is safe to downcast the object to it.

as_orthographic_camera_ptr(self: alias_api.AlObject) → AlOrthographicCamera: Return a non-null pointer to an AlOrthographicCameraPtr if it is safe to downcast the object to it.

as_perspective_camera_ptr(self: alias_api.AlObject) → AlPerspectiveCamera: Return a non-null pointer to an AlPerspectiveCameraPtr if it is safe to downcast the object to it.

as_shader_ptr(self: alias_api.AlObject) → AlShader: Return a non-null pointer to an AlShader if it is safe to downcast the object to it.

as_surface_node_ptr(self: alias_api.AlObject) → AlSurfaceNode: Return a non-null pointer to an AlSurfaceNode if it is safe to downcast the object to it.

as_surface_ptr(self: alias_api.AlObject) → AlSurface: Return a non-null pointer to an AlSurface if it is safe to downcast the object to it.

as_switch_shader_ptr(self: alias_api.AlObject) → AlSwitchShader: Return a non-null pointer to a AlSwitchShader if it is safe to downcast the object to it.

bounding_box(self: alias_api.AlDagNode) → Tuple[int, List[List[float[4]][8]]]: Returns the eight corners of the bounding box in world space.

comment(self: alias_api.AlDagNode) → Tuple[int, int, str]: Obtain the size and address of a block of textual data associated with the object.

copy_object(*args, **kwargs)

Overloaded function.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions = None) -> alias_api.AlDagNode

Copy this AlDagNode returning a pointer to the new copy.

copy_object(self: alias_api.AlDagNode, options: AlDagNode::AlCopyOptions, num_of_blind_data_ids_to_copy: int, blind_data_ids_to_copy: int) -> alias_api.AlDagNode

Return an exact duplicate of this AlDagNode wrapper.

copy_transform(self: alias_api.AlDagNode, node: alias_api.AlDagNode) → int: Copy the local transformation from the given node on to this node.

copy_wrapper(self: alias_api.AlTextureNode) → alias_api.AlObject: Return an exact duplicate of this AlTextureNode wrapper.

create_symmetric_geometry(self: alias_api.AlDagNode) → int: Create the symmetric geometry for this node if it is on a symmetric plane.

delete_object(self: alias_api.AlTextureNode) → int: Delete the AlTextureNode from the Alias Universe and return the status of the performed operation.

do_updates(self: alias_api.AlDagNode, new_state: int = 1) → int: The doUpdate flag is used to notify the system that you are finished performing. If this flag is True, then it is equivalent to sending out a ‘geometry modified’ message to the rest of the system.

get_surface_orientation(self: alias_api.AlDagNode) → Tuple[int, int]: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

global_transformation_matrix(*args, **kwargs)

Overloaded function.

global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the global transformation matrix for the object.

global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the global transformation matrix for the object.

inverse_global_transformation_matrix(*args, **kwargs)

Overloaded function.

inverse_global_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the inverse global transformation matrix for the object.

inverse_global_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the inverse global transformation matrix for the object.

is_a_construction_plane(self: alias_api.AlDagNode) → int: Return True if the dag node is a construction plane.

is_ancestor_an_instance(self: alias_api.AlDagNode) → int: Returns True if this AlDagNode or one of its ancestors is an instance node, else False.

is_display_mode_set(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType) → int: Return true if the specified display mode is set (on), else false.

is_instanceable(self: alias_api.AlDagNode) → int: Return True. An AlDagNode is instanceable by default, unless overridden by derived class.

is_instanced(self: alias_api.AlDagNode) → int: Return True if this is an instance node.

is_picked(self: alias_api.AlPickable) → int: Return True if the object is picked.

layer(self: alias_api.AlDagNode) → alias_api.AlLayer: Returns layer the node is assigned.

local_rotate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node rotation based on the setting of the local axes.

local_rotation_angles(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: These angles allow you to determine how the local rotation axis have been rotated from their initial position.

local_rotation_axes(self: alias_api.AlDagNode) → Tuple[int, List[float[3]], List[float[3]], List[float[3]]]: Return the vectors representing the local rotation axes for this node. These axes are the three axes vectors in the world space co-ordinates.

local_transformation_matrix(*args, **kwargs)

Overloaded function.

local_transformation_matrix(self: alias_api.AlDagNode, matrix: alias_api.AlTM) -> int

Compute the local transformation matrix for the object.

local_transformation_matrix(self: alias_api.AlDagNode) -> Tuple[int, List[List[float[4]][4]]]

Compute the local transformation matrix for the object.

local_translate_by(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Perform a dag node translation based on the setting of the local axes.

property name: Get or set the AlDagNode name.

next_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s next sibling AlDagNode or None if there is no next sibling.

parent_node(self: alias_api.AlDagNode) → AlGroupNode: Returns the parent group node.

pick(self: alias_api.AlPickable) → int: Pick the object

prev_node(self: alias_api.AlDagNode) → alias_api.AlDagNode: Return a pointer to the object’s previous sibling AlDagNode or None if there is no next sibling.

remove_blind_data(self: alias_api.AlDagNode, user_type: int) → int: Remove the block of data of the given type from the object.

remove_comment(self: alias_api.AlDagNode) → int: Remove the block of text associated with this object from the object itself.

remove_joint(self: alias_api.AlDagNode) → int: Remove the AlJoint to this dag node to maintain IK information.

rotate_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the rotation pivot position in world space.

rotation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of rotation (in degrees) about the x, y, and z axes.

scale(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the amount of scale in the x, y, and z direction.

scale_pivot(self: alias_api.AlDagNode) → Tuple[int, alPyMath::Vec3]: Returns a vector that represents the scale pivot position in world space.

search_across(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search across the DAG tree (starting at the current node), for a dag node with a specific ‘name’.

search_below(self: alias_api.AlDagNode, name: str) → alias_api.AlDagNode: Search the DAG tree (rooted at the child of the current node), for a dag node with a specific ‘name’.

send_geometry_modified_message(self: alias_api.AlDagNode) → int: Send out an update message notifying that the geometry of this dag node has been modified.

set_blind_data(self: alias_api.AlDagNode, user_type: int, size: int, data: str) → int: Associates a block of ‘data’ with the object.

set_comment(self: alias_api.AlDagNode, size: int, data: str) → int: Associates a block of textual ‘data’ with the object.

set_display_mode(self: alias_api.AlDagNode, mode: alias_api.AlDisplayModeType, on: int) → int: Set the display mode (by name) for this dag node.

set_layer(*args, **kwargs)

Overloaded function.

set_layer(self: alias_api.AlDagNode, layer: alias_api.AlLayer) -> int
Set the layer on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer

The layer object to be assigned to the AlDagNode

type layer

AlLayer

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)
set_layer(self: alias_api.AlDagNode, layer_number: int) -> int
Set the layer ID on the dag node.

When a layer is set to an AlDagNode, the following settings are done:
All the child nodes of the current node are automatically assigned to the layer object.

All the parent nodes are automatically assigned to the default layer.

All the sibling nodes are unaffected.
param layer_number

The layer number to be assigned to the AlDagNode

type layer_number

int

return

The status code result Success - the layer was assigned successfully InvalidArgument - the layer number is invalid InvalidObject - the dag node was invalid

rtype

int(AlStatusCode)

set_local_rotation_angles(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Setting the local rotation angles is the only means by which the local rotations axes can be modified.

set_local_rotation_axes(self: alias_api.AlDagNode, arg0: List[float[3]], arg1: List[float[3]], arg2: List[float[3]]) → int: Set the local rotation axes of this dag node to the given world space vectors.

set_rotate_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the rotate pivot and return the status code result of the operation.

set_rotation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the amount of rotation (in degress) about the x, y, z axes. The rotation will be done after the scale transformation and before the final local translation.

set_scale(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the local scale vector. The scale transformation will be done before the local rotations. There is no restriction on the values of the components of the scale vector.

set_scale_pivot(self: alias_api.AlDagNode, p: alPyMath::Vec3) → int: Set the scale pivot and return the status code result of the operation.

set_surface_orientation(self: alias_api.AlDagNode, flag: int) → int: Set the ‘opposite’ flag of the surface or mesh in ‘node’.

set_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final local translation vector. The translation transformation will be done after rotations.

set_world_translation(self: alias_api.AlDagNode, x: float, y: float, z: float) → int: Set the final world translation vector.

translation(self: alias_api.AlDagNode) → Tuple[int, float, float, float]: Return the final local translation vector.

type(self: alias_api.AlTextureNode) → alias_api.AlObjectType: Return the AlTextureNode type identifier.

unpick(self: alias_api.AlPickable) → int: Unpick the object

update_draw_info(self: alias_api.AlDagNode) → int: Force the internal draw information to be updated to match the dag node’s geometry.

version(self: alias_api.AlDagNode) → int: Return the version of the dag node.

AlTM

class alias_api.AlTM

Bases: pybind11_builtins.pybind11_object

assign(self: alias_api.AlTM, row: int, col: int, value: float) → None: Set the AlTM matrix value at the row and column index.

decompose(self: alias_api.AlTM) → Tuple[int, List[float[3]], List[float[3]], List[float[3]], List[float[3]]]: Decompose the transform matrix into translate, rotate, scale and shear vectors.

static diagonal(d0: float, d1: float, d2: float, d3: float) → alias_api.AlTM: Return a zero matrix with diagonal values of ‘d’.

get_tm(self: alias_api.AlTM) → Tuple[int, List[List[float[4]][4]]]: Return the contents of the AlTM into a 4x4 array.

static identity() → alias_api.AlTM: Return the identity matrix.

inverse(self: alias_api.AlTM) → alias_api.AlTM: Return the inverse of the matrix.

static rotate(x: float, y: float, z: float, angle: float) → alias_api.AlTM: Return a transformation matrix to rotate counterclockwise about the axis (x, y, z).

static rotate_x(rx: float) → alias_api.AlTM: Return a transformation matrix to rotate about the x-axis.

static rotate_y(ry: float) → alias_api.AlTM: Return a transformation matrix to rotate about the y-axis.

static rotate_z(rz: float) → alias_api.AlTM: Return a transformation matrix to rotate about the z-axis.

static scale(d: float) → alias_api.AlTM: Return a transformation matrix to scale a point (x, y, z) by a constant with a value of ‘d’.

static scale_nonp(sx: float, sy: float, sz: float) → alias_api.AlTM: Return a transformation matrix to non-proportionally scale a point (x, y, z) by ‘sx’ in the x-axis, ‘sy’ in the y-axis, and ‘sz’ in the z-axis.

set_tm(self: alias_api.AlTM, tm: List[List[float[4]][4]]) → int: Copies the given 4x4 transform matrix into this AlTM.

trans_normal(self: alias_api.AlTM, x: float, y: float, z: float) → Tuple[int, float, float, float]: Using the transformation matrix, transform the normal (x,y,z).

trans_point(*args, **kwargs)

Overloaded function.

trans_point(self: alias_api.AlTM, d: List[float[4]]) -> Tuple[int, List[float[4]]]

Return the resulting point by transforming the point ‘d’ using this matrix.

trans_point(self: alias_api.AlTM, x: float, y: float, z: float, w: float) -> Tuple[int, float, float, float, float]

Using the transformation matrix, transform the point (x,y,z,w).

trans_point(self: alias_api.AlTM, x: float, y: float, z: float) -> Tuple[int, float, float, float]

Using the transformation matrix, transform the point (x,y,z,1).

trans_vector(self: alias_api.AlTM, x: float, y: float, z: float) → Tuple[int, float, float, float]: Using the transformation matrix, transform the vector (x,y,z,1).

static translate(arg0: float, arg1: float, arg2: float) → alias_api.AlTM: Return a transformation matrix to translate a point (x, y, z) by (tx, ty, tz).

transpose(self: alias_api.AlTM) → alias_api.AlTM: Return the transpose of the matrix.

static zero() → alias_api.AlTM: Return the zero matrix.

AlWindow

class alias_api.AlWindow