alias_api.AlSwitchShader

class alias_api.AlSwitchShader

Bases: AlObject

Base object for representing shader data

This class encapsulates the basic functionality for checking and setting the name of a shader as well as accessing the textures that a particular shader refers to, and the animation on the shader. Shader objects are accessible through both the AlUniverse class and the objects that reference them (AlSurface and AlFace classes).

A switch shader object may reference shaders. The first_shader() and next_shader() methods are used to access these textures.

first_shader() returns the first shader that the shader object references. next_shader() moves from a given referenced shader to the next shader in order, as related to the switch shader object.

add_shader(self: alias_api.AlSwitchShader, shader: alias_api.AlShader) → bool

Add a shader to the switch shader.

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.

get_active_shader(self: alias_api.AlSwitchShader) → alias_api.AlShader

Return the current active shader.

get_first_inactive_shader(self: alias_api.AlSwitchShader) → alias_api.AlShader

Returns the first inactive shader.

get_next_inactive_shader(self: alias_api.AlSwitchShader, cur_shader: alias_api.AlShader) → alias_api.AlShader

get the next inactive shader.

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.

remove_shader(self: alias_api.AlSwitchShader, shader: alias_api.AlShader) → bool

Remove a shader to the switch shader.

set_active_shader(self: alias_api.AlSwitchShader, shader: alias_api.AlShader) → None

Set the current active shader.

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

Return the AlSwitchShader type identifier.