alias_api.AlShell
- class alias_api.AlShell
Bases:
AlObjectInterface to Alias nurbs surface geometry.
A shell is a collection of surfaces which behave as a single object. Each surface can have its own set of trim curves. A cube with six square sides is a shell. The cube can be assigned a single shader and rendering formation. The cube is made of a collection of 6 spline surfaces.
The AlTrimRegions are inaccurately named. They actually represent the surfaces in the shell.
- 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.
- 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)
- 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.
- 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.