alias_api.AlObject

class alias_api.AlObject

Bases: AlHashable

Base class for all Alias Data types.

This is an abstract base class which holds a reference to an anonymous data structure. Derived classes will initialize the reference to refer to a particular data structure. This class provides a mechanism for completely hiding the internal data structures from the user.

This class gives some homogeneity between several different classes by providing methods which derived classes will redefine so that the name and type of the object can be obtained and so that object down casting can be done safely.

There are a group of functions (the ‘downcasting’ methods )for casting an AlObject to one of its derived classes. They have the form

Al{DerivedObject} *AlObject::as{DerivedObject}Ptr()

where {DerivedObject} is the name of the derived class.

All these functions return NULL in the base class, and the derived class of the appropriate type simply returns a pointer to itself. In this way, safe typecasting can be maintained.

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

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

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

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_arc_attributes_ptr(self: alias_api.AlObject) → AlArcAttributes: Return a non-null pointer to an AlArcAttribute if it is safe to downcast the object to it.

as_attributes_ptr(self: alias_api.AlObject) → AlAttributes: Return a non-null pointer to an AlAttributes if it is safe to downcast the object 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_channel_ptr(self: alias_api.AlObject) → AlChannel: Return a non-null pointer to an AlChannel if it is safe to downcast the object to it.

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

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

as_cluster_node_ptr(self: alias_api.AlObject) → AlClusterNode: Return a non-null pointer to an AlClusterNode 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_clusterable_ptr(self: alias_api.AlObject) → alias_api.AlClusterable: Return a non-null pointer to an AlClusterable if it is safe to downcast the object to it.

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

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

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

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

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

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

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

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

as_curve_ptr(self: alias_api.AlObject) → AlCurve: Return a non-null pointer to an AlCurve 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_deviation_locator_ptr(self: alias_api.AlObject) → AlDeviationLocator: Return a non-null pointer to an AlDeviationLocator if it is safe to downcast the object to it.

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

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

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

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

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

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

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

as_keyframe_ptr(self: alias_api.AlObject) → AlKeyframe: Return a non-null pointer to an AlKeyframe 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_light_node_ptr(self: alias_api.AlObject) → AlLightNode: Return a non-null pointer to an AlLightNode if it is safe to downcast the object to it.

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

as_line_attributes_ptr(self: alias_api.AlObject) → AlLineAttributes: Return a non-null pointer to an AlLineAttributes 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_minmax_locator_ptr(self: alias_api.AlObject) → AlMinmaxLocator: Return a non-null pointer to an AlMinmaxLocator 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_param_action_ptr(self: alias_api.AlObject) → AlParamAction: Return a non-null pointer to an AlParamAction 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_plane_attributes_ptr(self: alias_api.AlObject) → AlPlaneAttributes: Return a non-null pointer to an AlPlaneAttributes if it is safe to downcast the object to it.

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

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

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

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

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

as_settable_ptr(self: alias_api.AlObject) → alias_api.AlSettable: Return a non-null pointer to an AlSettable 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_shell_node_ptr(self: alias_api.AlObject) → AlShellNode: Return a non-null pointer to an AlShellNode if it is safe to downcast the object to it.

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

as_space_point_ptr(self: alias_api.AlObject) → AlSpacePoint: Return a non-null pointer to an AlSpacePoint 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_point_ptr(self: alias_api.AlObject) → AlSurfacePoint: Return a non-null pointer to an AlSurfacePoint 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.

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

as_texture_ptr(self: alias_api.AlObject) → AlTexture: Return a non-null pointer to an AlTexture 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.