alias_api.AlCloud

class alias_api.AlCloud

Bases: AlObject

Interface to Alias clouds.

AlCloud is the interface to clouds and their data in Alias. This class allows a developer to perform operations such as creating, naming, controlling visibility, setting transformations, picking, merging, tesselating and subsetting a cloud of points. In addition, points can be added to a cloud that was created with the API. Data access methods to most of the settings are also provided. For example you can find the current translation, scale or pick state etc.

The number of points in a cloud and the actual points can be retrieved with the class. Please see the points() routine for a description of the data structure used to retrieve points. The same data structure is used in the add_points() method.

Importing a cloud of points is performed by the method AlUniverse::importCloudFile(). Walking the cloud list is performed with AlUniverse.first_cloud() in conjunction with AlCloud:next_cloud(). Also apply_iterator_to_clouds() can be used to walk all cloud elements.

Notes:

1. Tesselation of clouds will only work with CyberWare files. As a result, clouds created with the API cannot be tesselated.

Clouds are not in the Alias dag tree.

3. A cloud will not be an item on the Alias pick list. Therefore, AlCloud pick methods must be used instead of AlPickList methods.

4. To add arbitrary points to a cloud, you must create a cloud with the new points and merge it into the existing cloud that you wish to grow. The cloud that is merged in will be delete automatically in the merge process. The new extended cloud will have the outer bounding box of the two clouds.

5. import_cloud_file() has a parameter which controls the sampling factor when the cloud file is imported.

copy_wrapper(self: alias_api.AlCloud) → alias_api.AlObject: Return an exact duplicate of this AlCloud wrapper.

delete_object(self: alias_api.AlCloud) → int: Delete the AlCloud from the Alias Universe and return the status of the performed operation.

property name: Get or set the AlCloud name.

type(self: alias_api.AlCloud) → alias_api.AlObjectType: Return the AlCloud type identifier.