alias_api

Python bindings to Alias C++ API

Functions

add_message_handler(message_type, callback_func)	Install a message handler in the Alias Universe.
adjust_window(hwnd)	Adjust the specified child window such that it is centered over the Alias main window.
al_are_equal(al_object1, al_object2)	Return True if the two Alias Objects are equal, else False.
al_is_valid(al_object)	Return True if the Alias Object is valid, else False.
apply_iterator_to_dag_nodes(iter, retcode)	Applies the iterator to all AlDagNodes.
apply_iterator_to_shaders(iter, retcode)	Apply the iterator to each AlShader.
assign_children_to_parent_layer(*args, **kwargs)	Overloaded function.
assign_nodes_to_layer(*args, **kwargs)	Overloaded function.
cleanup_geometry_model([face_to_surf, ...])	Clean up the geometry of the model.
clear_pick_list()	Remove all objects from the pick list.
clear_queued_events()	Clear the currently queued events.
convert_face_node_to_trimmed_surface_node(node)	Convert a AlFaceNode to AlSurfaceNode (a trimmed surface).
convert_to_trimmed_surface_node(node)	This function works on a AlSurfaceNode only, and only on a surface that is a closed/periodic and untrimmed surface (e.g.
copy_object(node[, run_cleanup])	This function performs the copy of the dag node based on the copy options that have been set with the setCopyOptionFlags() routine.
copy_object_cleanup()	Call this method after performing a number of dag node copy object operations to clean up the scene.
create_alternative(name[, force])	Create an AlReferenceFileSet in the Alias Universe.
create_construction_plane(tm)	Create a dag node that is a construction plane at the position denoted by 'tm'.
create_group_for_layer(layer_name, group_name)	Create a group node for the specified layer.
create_layer(layer_name)	Create a new AlLayer in the Alias Universe.
create_layer_folder(folder_name)	Create a new AlLayer folder in the Alias Universe.
create_layered_shader()	Create a new AlLayeredShader in the Alias Universe.
create_orthographic_camera(view_type)	Create and return an AlOrthographicCamera object.
create_perspective_camera()	Create and return a AlPerspectiveCamera object.
create_reference(arg0)	Create an AlReferenceFile with the given path, in the Alias Universe.
create_reference_alternative(name)	Create an AlReferenceFileSet with the given name.
create_shader()	Create a new AlShader in the Alias Universe.
create_stage(arg0)	Create a new stage in Alias.
create_switch_shader()	Create a new AlSwitchShader in the Alias Universe.
create_texture_node(*args, **kwargs)	Overloaded function.
current_window()	Returns the currently active window.
delete_all(objs)	Delete all the Alias Objects in the list.
delete_all_construction_entities()	Delete all AlConstructionPlane objects found in the Alias Universe.
delete_all_construction_history(cos)	Delete the construction histor for all the given curve on surface objects.
delete_all_locators()	Delete all locators.
delete_construction_history(cos)	Delete the construction histor for the curve on surface.
delete_dag_nodes_by_name(node_names)	Delete the dag nodes with the given names.
delete_history(*args, **kwargs)	Overloaded function.
delete_layers_by_name(layer_names)	Delete the layers with the given names.
delete_null_nodes()	Delete all null nodes in the Alias scene.
delete_sets_by_name(names)	Delete sets by name.
do_updates([new_state])	The do_updates flag is used to notify the system that you are finished performing.
expand_instances(node)	Convert all instsances below the given node (top node of tree) to uninstanced geometry.
export_by_layer(target_dirname, ...[, overwrite])	Export each layer to a new file.
export_by_layer_sequentially(target_dirname, ...)	Export each layer to a new file.
find_dag_node_by_name(name)	Find and return the DagNode that matches the given name.
find_top_level_dag_node_by_name(name)	Find and return the DagNode that matches the given name.
first_construction_entity()	Return the first AlConstructionPlane object found in the Alias Universe.
first_dag_node()	Return the first AlDagNode in the list of Alias AlDagNode objects (the DAG).
first_environment()	Returns the first Environment in the list of Alias Environment objects.
first_layer()	Return the first layer which refers to the default layer.
first_layered_shader()	Return the first AlLayeredShader in the list of Alias AlLayeredShader objects.
first_locator()	Return the first AlLocator in the list of Alias AlLocator objects.
first_pick_item()	Set the pick list to reference the first object in the list.
first_set()	Return the first set in the Alias Universe.
first_shader()	Return the first AlShader in the list of Alias AlShader objects.
first_switch_shader()	Return the first AlSwitchShader in the list of Alias AlSwitchShader objects.
flatten_group_nodes(*args, **kwargs)	Overloaded function.
get_alternative_by_name(name)	Return the AlReferenceFileSet matching the given name.
get_alternatives()	Return a list of all the alternatives for the current AlReferenceFileSet.
get_annotation_locator_strings()	Return the string value for all annotation locators in the Alias Universe.
get_annotation_locators()	Return all annotation locators in the Alias Universe.
get_bounding_box_from_hanger(node)	Return the bounding box computed from the bounding box hanger for the dag node.
get_children(arg0)	Return a list of all the children in the group node.
get_construction_plane_by_name(name)	Return the AlConstructionPlane matching the given unique name.
get_current_path()	Return the current file path.
get_current_pick_item()	Return the object that the pick list is currently referencing.
get_current_stage()	Return the current stage.
get_dag_nodes_by_name(names)	Returns a list of the dag nodes matching the given names.
get_empty_layers([include_folders, skip_layers])	Return all empty layers.
get_empty_sets()	Return a list of all empty sets in the Alias Universe.
get_layer_by_name(layer_name)	Return a layer given its name in the Alias Universe.
get_layer_by_number(layer_number)	Return a layer given its number in the Alias Universe.
get_layered_shader_by_name(shader_name)	Return the AlLayeredShader found by the given name.
get_layered_shader_by_node(node_name)	Return the AlLayeredShader assigned to the node corresponding to the given name.
get_layered_shaders()	Return a list of all the AlLayeredShader objects in the Alias universe.
get_layers(*args, **kwargs)	Overloaded function.
get_layers_by_name(layer_names)	Return the AlLayer objects found from the given list of names.
get_layers_using_multiple_shaders()	Return layers whose geometry do not all use the one same shader.
get_locator_by_name(name)	Return the AlLocator object with the given name.
get_locators()	Return a list of all AlLocator objects in the Alias Universe.
get_locators_by_name(names)	Return a list of AlLocator objects with the given names.
get_main_window_id()	Return the window handle to the Alias main window.
get_nesting_groups()	Return the list of top-level group nodes that contain at least one group.
get_perspective_camera_by_name(name)	Find and return the AlPerspectiveCamera that matches the unique identifier name.
get_perspective_cameras()	Find and return all AlPerspectiveCameras in the Alias Universe.
get_pick_item_dag_nodes()	Return a list of all dag nodes that are in the pick list.
get_pick_items()	Return a list of all objects that are in the pick list.
get_product_information()	Return the Alias product information.
get_reference_by_name(name)	Return the AlReferenceFile matching the given name.
get_reference_by_path(path)	Return the AlReferenceFile matching the given file path.
get_reference_by_uuid(uuid)	Return the AlReferenceFile matching the given uuid.
get_references()	Return all the AlReferenceFiles imported into the current file.
get_references_by_name(names)	Return the AlReferenceFile objects matching the given list of names.
get_sets_by_name(names)	Get sets by name.
get_shader_by_name(shader_name)	Return the Shader found by the given name.
get_shaders()	Return a list of all the shaders in the Alias universe.
get_shaders_by_name(shader_names)	Return the Shader objects found by the given list of names.
get_shaders_by_node(node_name)	Return a list of all the shaders assigned to the node corresponding to the given name.
get_stages()	Return all the existing stages of the current Alias session.
get_switch_shader_by_name(shader_name)	Return the SwitchShader found by the given name.
get_switch_shader_by_node(node_name)	Return the switch shader assigned to the node corresponding to the given name.
get_switch_shaders()	Return a list of all the switch shaders in the Alias universe.
get_top_dag_nodes()	Returns a list of the top level dag nodes in the Alias Universe.
get_variants()	Return all the variants of the current file.
has_annotation_locator()	Return True if there are any annotation locators in the Alias Universe.
has_construction_history(cos)	Return 1 if the curve on surface has construction history, 0 if no construction history, and -1 if the curve on surface is invalid.
has_history(node)	Return True if the dag node has history, else False.
has_queued_events()	Check if there are Alias event callbacks queued and waiting to execute.
has_reference()	Return True if any AlReferenceFiles found in the current Alias Universe.
has_variants()	Check if the current file contains variants.
import_file(arg0)	Import a file into the current file.
import_reference(filename)	Import the file and create an AlReferenceFile object from it.
import_subdiv(filepath)	Imports a subdiv data from OBJ, TSM, F3D or SF3D file.
import_subdivision(filepath)	Deprecated - use 'import_subdiv' instead.
initialize_universe(up, init_project_env)	Initialize the Alias Universe.
is_construction_layer(layer_number)	Determine if the layer is a construction layer.
is_copy_of_vred_shader(shader)	Returns True if the shader was created from a VRED shader.
is_empty_file()	Deprecated - use 'is_stage_empty' instead.
is_queuing_events()	Check if the Alias event callbacks are currently being queued.
is_stage_empty()	Check if the current file is empty or not.
linear_scale(type)	Return the linear scale factor for the current units.
linear_units(type)	Return the linear units for the current units.
log_message(outputType, msg)	A function which logs a message to the given output.
log_to_errlog(msg)	A function which logs a message to the Alias error log.
log_to_prompt(msg)	A function which logs a message to the Alias prompt.
log_to_prompt_no_history(msg)	A function which logs a message to the Alias prompt without history.
log_to_stderr(msg)	A function which logs a message to the standard error stream.
log_to_stdout(msg)	A function which logs a message to the standard output stream.
next_construction_entity(entity)	Return the next AlConstructionPlane object found, after the given entity, in the Alias Universe.
next_layer(cur_layer)	Return the leaf layer following cur_layer in the graph of Alias AlLayer objects in a pre-order traversal.
next_locator(cur_locator)	Return the AlLocator following cur_locator in the list of Alias AlLocator objects.
next_pick_item()	Set the pick list to reference the next object in the list.
next_shader(*args, **kwargs)	Overloaded function.
next_switch_shader(cur_shader)	Return the AlSwitchShader following cur_shader in the list of Alias AlSwitchShader objects.
node_first_shader(node)	Return the first shader used by the given dag node.
node_switch_shader(node)	Return the switch shader used by the given dag node.
open_file(path[, new_stage, delete_current])	Open a file in Alias.
pick(pickables)	Pick all the given objects.
pick_all_layers()	Pick all layers in the Alias Universe.
pick_all_locators()	Pick all locators.
pick_by_name(name)	Add all objects that match the given string pattern to the pick list.
pick_layers(*args, **kwargs)	Overloaded function.
pick_locators(*args, **kwargs)	Overloaded function.
pick_nodes(*args, **kwargs)	Overloaded function.
pick_nodes_assigned_to_layers(*args, **kwargs)	Overloaded function.
pick_nodes_assigned_to_shaders(*args, **kwargs)	Overloaded function.
pop_pick_list()	Pops the pushed pick list.
prev_pick_item()	Set the pick list to reference the previous object in the list.
push_pick_list(copy)	Push a new pick list onto the stack.
queue_events(queue)	Manage queuing Python callbcacks triggered by Alias message events.
redraw_screen([redraw_flag])	Redraw the Alias screen.
remove_message_handler(message_type, callback_id)	Remove the specific message handler for the message type and callback.
remove_message_handlers(message_type)	Remove all message handlers for the message type.
remove_reference(reference_file)	Remove the AlReferenceFile from the Alias Universe.
remove_references(reference_files)	Remove all the AlReferenceFile from the Alias Universe.
reset()	Deprecated - use 'reset_stages' instaed.
reset_pivots(*args, **kwargs)	Overloaded function.
reset_stages()	Reset the current session by deleting all the stages.
retrieve(file_name)	Retrieves an Alias Wire file and adds the objects stored in the file to the list of Alias AlDagNode objects.
retrieve_options()	Get the options used by retrieve().
save_file()	Save the current file.
save_file_as(path)	Save the current file to the given path.
save_layers(file_path, target_dirname, ...)	Retrieve the file and export each of its layers to a new file.
search_dag(input_data)	Search the entire DAG validating each node with the provided input data.
search_node_has_history(input_data)	Search the entire DAG for nodes with construction history.
search_node_has_non_origin_pivot(input_data)	Search the entire DAG for nodes with scale or rotate pivots not positioned at the origin.
search_node_has_non_zero_transform(input_data)	Search the entire DAG for nodes that do not have a zero transform.
search_node_is_instance(input_data[, expand])	Search the entire DAG for nodes that are instances.
search_node_is_template(input_data)	Search the entire DAG for nodes that are templates.
search_node_layer_does_not_match_parent_layer(...)	Search the entire DAG for nodes that do not have the same layer assigned as their parent node.
search_node_unused_curves_on_surface(input_data)	Search the DAG for nodes that have unused curves on surface.
search_node_unused_curves_on_surface_with_history(...)	Search the DAG for nodes that have unused curves on surface.
set_layer_symmetry(*args, **kwargs)	Overloaded function.
set_parent_window(hwnd)	Set the parent window of the specified child window to the main Alias window.
set_retrieve_options(options)	Set the options used by retrieve().
set_store_options(options)	Set the options used by store().
store(*args, **kwargs)	Overloaded function.
store_active(file_name, file_type)	This method allows the user to store only those objects which are on the pick list.
store_current_window(filename[, width, ...])	Save the current Alias window to a file.
store_options()	Get the options used by store().
tessellate_adaptive(node, type, min, max, ...)	This method causes geometry below the AlDagNode to be subdivided into polygons depending on the curvature of the surface.
tessellate_chord_height_deviation(node, ...)	This method tessellates a dag using a chord height deviation tolerance. The chord height deviation
tessellate_chord_height_deviation_accurate(...)	This method tessellates a dag node using a chord height deviation tolerance and the accurate tessellator.
tessellate_chord_height_deviation_fast(node, ...)	This method tessellates a dag using a chord height deviation tolerance.
tessellate_number(node, type, total, ...)	This method repeatedly tessellates the surfaces with different adaptive subdivision parameters until settings are found that produce a total polygon count close to the requested number.
tessellate_render_settings(node, type)	This method causes the geometry below the AlDagNode to be subdivided into polygons in according to
tessellate_uniform(node, type, alongU, alongV)	This method causes the geometry below the AlDagNode to be subdivided into polygons in a uniform manner.
traverse_dag(*args, **kwargs)	Overloaded function.
ungroup(*args, **kwargs)	Overloaded function.
unpick(pickables)	Unpick all the given objects.
unpick_all_layers()	Unpick all layers in the Alias Universe.
unpick_all_locators()	Unpick all locators.
update_reference(old_path, new_path)	Update an AlReferenceFile path with the new path provided.
zero_transform(*args, **kwargs)	Overloaded function.
zero_transform_top_level()	Apply zero transform to all top-level dag nodes in the universe.

Classes

AlAction	Basic interface to Alias actions
AlActionExtrapType	Pre- and Post- extrapolation (infinite) types for actions
AlAngleLocator	Displays the included angle between three locators.
AlAnimatable	Basic Interface to Alias objects which support animation.
AlAnnotationLocator	Displays a text string for existing locators
AlArcAttributes	Interface to Alias arc curve attributes.
AlAttributes	Interface to Alias curve and surface attributes.
AlCamera	A base class that encapsulates behavior of perspective and orthographic cameras.
AlCameraNode	Dag node class for cameras.
AlChannel	Basic interface to Alias channels
AlChannelDataType	The type of channel.
AlCloud	Interface to Alias clouds.
AlCluster	Encapsulates creation, deletion and manipulation of clusters.
AlClusterMember	Basic Interface to the object representing the relationship between an item and a cluster that it belongs to.
AlClusterNode	The dag node class for clusters.
AlClusterable	Encapsulates methods common to Alias objects which can belong to clusters.
AlConicAttributes	Interface to Alias conic curve attributes.
AlConicType	The type of conic curve.
AlConstructionEntity	Base class for Alias construction entities.
AlConstructionPlane	Interface to Alias construction planes.
AlCoordinateSystem	The coordinate system.
AlCopyOptions	Copy options for AlDagNode.
AlCurve	Interface to Alias nurbs curves geometry.
AlCurveAttributes	Interface to Alias curve attributes.
AlCurveCV	Encapsulates methods common to curve CVs.
AlCurveFormType	Curve form types.
AlCurveNode	A dag node that refers to a nurbs curve's geometry.
AlCurveNodeJoinErrors	Curve node join errors.
AlCurveOnSurface	Interface to curves on surfaces geometry.
AlCurveOnSurfacePoint	Interface to Alias curve on surface points
AlCurvePoint	Interface to Alias curve points.
AlDagNode	// py::class_<AlDagNode, AlObject, AlPickable, std::unique_ptr<AlDagNode>>( m, "AlDagNode", R"doc(
AlDeviationLocator	Interface to Alias deviation locator.
AlDisplayModeType	Display mode types.
AlDistanceLocator	Displays the distance between two locators.
AlEnvironment	Base object for representing shader environment data
AlFace	Interface to Alias face curves.
AlFaceNode	Interface to the dag node that gives access to faces.
AlFileType	File types
AlGroupNode	A dag node which can contain a list of dag nodes.
AlHashable	Base class for objects which can be inserted into an AlDictionary.
AlIKHandle	Interface to Inverse Kinematics Handles.
AlIKHandleNode	Interface to dag nodes of IK handles.
AlIterator	A base class used to derive iterators for performing tasks on elements of a list.
AlKeyframe	Basic interface to Alias keyframes on parameter curve actions.
AlLayer	Interface to Alias layer objects.
AlLayeredShader	Base object for representing shader data
AlLight	Encapsulates methods common to all lights.
AlLightNode	The dag node class for lights.
AlLineAttributes	Interface to Alias line attributes.
AlLinkItem	Base class for objects contained in an AlList.
AlList	Simple List class for AlLinkItem objects.
AlLocator	Contains functionality common to all the Alias locators
AlMesh	Interface to Alias meshes.
AlMeshNode	A dag node that refers to a mesh's geometry.
AlMessageType	The type of message
AlMinmaxLocator	Interface to Alias Min Max locators.
AlObject	Base class for all Alias Data types.
AlObjectType	Alias object types.
AlOrthographicCamera	Orthographic modeling cameras.
AlParamAction	Basic interface to derived class of actions for parameter curve actions.
AlPerspectiveCamera	Encapsulates creation, deletion and manipulation of perspective cameras
AlPickable	Basic Interface to Alias objects which can be picked.
AlPlaneAttributes	Interface to Alias plane surface attributes.
AlPoint	Contains functionality common to all Alias construction entity points.
AlPointType	The type of point.
AlRadialLocator	Interface to Alias Radial locators
AlReferenceFile	A base class that encapsulates access to Reference File.
AlReferenceFileSet	A base class that encapsulates access to Reference File Sets.
AlReferenceLayer	A base class that encapsulates access to Reference Layers.
AlRetrieveOptions	A structure used to transfer options that control the retrieve() method.
AlRevSurfAttributes	Interface to Alias revolved surface attributes.
AlSet	Basic Interface to Alias set structures.
AlSetMember	Basic Interface to the members of Alias set structures.
AlSettable	Encapsulates methods common to Alias objects which can belong to sets.
AlShader	Base object for representing shader data
AlShadingFields	Types for shader methods.
AlShell	Interface to Alias nurbs surface geometry.
AlShellNode	Dag node class for shells.
AlSpacePoint	Interface to Alias space points.
AlStatusCode	Resulting operation status codes
AlStoreOptions	A structure used to transfer options that control the store() method.
AlSurface	Interface to Alias nurbs surface geometry.
AlSurfaceNode	Dag node class for nurbs surfaces.
AlSurfacePoint	Interface to Alias Surface points.
AlSwitchShader	Base object for representing shader data
AlTM	Basic Interface to Alias transformation matrix.
AlTangentType	The type of tangent.
AlTessellateTypes	The tessellation types.
AlTexture	Base object for representing texture data
AlTextureNode	Dag node class for solid textures.
AlTripleComponent	The component of an action that should be extracted when evaluating a channel.
AlWindow	Interface to the Alias modeling windows.
LinearUnit	Linear measurement units.
Menu	Add menus to the Alias menu bar using this object.
MenuItem	Menu items for the Menu object.
MessageResult	The result returned by a message event.
ReferenceFileStatus	The reference file status.
Stage	Class object to represetn a stage in Alias.
SymmetryState	The symmetry state.
TraverseDagInputData	Input data for traversing teh dag.
TraverseDagOutputData	Output data from traversing the dag.
Type	The type of measurment unit.
UngroupOption	Options for ungrouping
Variant	Class object to represent a variant in Alias.
Vec3	Class object to represent a 3D vector.
VectorAlTangentType	A list containing object of type AlTangentType

Exceptions

AliasCompatibilityException
AliasOpenModelException
AliasPythonException