alias_api.AlFace

class alias_api.AlFace

Bases: AlObject

Interface to Alias face curves.

An AlFace is derived from AlCurve and inherits AlCurve’s public methods.

AlFace objects are created independently from the AlFaceNode, and then added to the AlFaceNode afterwards. An AlFaceNode requires one valid AlFace object in order for it to be created. Other faces can be added to the list of faces under the AlFaceNode afterwards using AlFaceNode.add_face().

Deleting a face can cause one of two things to happen. If the AlFace is not under an AlFaceNode, or it is one of several faces under an AlFaceNode, then only the face will be deleted. If the AlFace is the only face under the AlFaceNode, then the AlFaceNode will also be deleted.

Each face curve must be planar and each face curve must lie in the same plane as all the others. In addition to the parent class (AlCurve) methods this class allows you to walk through the list of the face curves that make up the face.

All AlFace objects will have at least one shader attached to them. These can be accessed through the firstShader and nextShader methods.

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.

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.