alias_api.AlSurfaceNode

class alias_api.AlSurfaceNode

Bases: AlDagNode

Dag node class for nurbs surfaces.

AlSurfaceNode is the class used to access and manipulate surfaces within the dag.

This class behaves like other dag nodes (see AlDagNode for a description of the usage and purpose of dag nodes) and in addition allows users to add curves on surfaces and access the geometry of the surface via the surface() method. The surface() method returns a pointer to an AlSurface object which provides the user with the methods used to modify the geometry of the surface. Surfaces can be created from scratch by calling the AlSurfaceNode.create() method, or read in from a wire file.

copy_wrapper(self: alias_api.AlSurfaceNode) → alias_api.AlObject

Return an exact duplicate of this AlSurfaceNode wrapper.

create(self: alias_api.AlSurfaceNode, surface: alias_api.AlSurface) → int

Allocate the dag node and geometry required for this object.

This method must be called once and only once before any other method and only if the surface has been allocated by the user (e.g. not read in from a wire file). It is an error to call this method twice or if the object has been read in from a wire file.

Parameters

surface (AlSurface) – The surface to create this surface node for.

Returns

The status code result Success - the surface node was created InvalidArgument - the ‘surface’ was None or invalid Failure - the surface node was not created

Return type

AlStatusCode

delete_object(self: alias_api.AlSurfaceNode) → int

Delete the AlSurfaceNode from the Alias Universe and return the status of the performed operation.

has_history(self: alias_api.AlSurfaceNode) → bool

Return True if the surface node’s surface has construction history.

patch_precision(self: alias_api.AlSurfaceNode) → int

Return the patch precision for the surface. Return -1 if the surface is invalid.

set_patch_precision(self: alias_api.AlSurfaceNode, precision: SupportsInt) → int

Set the patch precision for the surface.

Parameters

precision (int) – The new patch precision (range is 2-64).

Returns

The status code result Success - the patch precision was set InvalidArgument - value for patch prevision was invalid InvalidObject - the surface node was invalid

Return type

AlStatusCode

surface(*args, **kwargs)

Overloaded function.

  1. surface(self: alias_api.AlSurfaceNode) -> alias_api.AlSurface

Return a the surface data structure which can be used to access the geometry of the surface.

  1. surface(self: alias_api.AlSurfaceNode, arg0: alias_api.AlTM) -> alias_api.AlSurface

Return a the surface data structure which can be used to access the geometry of the surface.

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

Return the AlSurfaceNode type identifier.