alias_api.AlLocator

class alias_api.AlLocator

Bases: AlObject

Contains functionality common to all the Alias locators

This virtual class encapsulates methods common to all the Alias locators, such as annotationLocator, distanceLocator, angleLocator, radialLocator, deviationLocator and minmaxLocator.

This class contains methods for picking, deleting, and naming locators. In addition, methods are available for working with layers and for changing invisibility and templated modes.

To create a locator, the user must instantiate and call the create method of a specific type of locator (eg. an angle locator ).

The annotation, distance and angle locators depend on one or more construction entities point types, such as a curve point. If a construction point is deleted, their dependent annotation, distance and angle locators are automatically deleted. Similarly, the radial, deviation and minmax locators are dependent on other objects. If those objects are deleted, the dependent radial, deviation, and minmax locators are also deleted.

The locator classes are derived as follows, where a class inherits the functionality defined in the class above it. The user can not instantiate the locator (AlLocator) class.

Locator

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

Return an exact duplicate of this AlLocator wrapper.

delete_object(self: alias_api.AlLocator) → int

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

property invisible

Get or set the AlLocator invisibility property.

is_picked(self: alias_api.AlLocator) → int

On successfully checking the locator, return 1 if the AlLocator is picked, else return 0. On failure to check, return -1.

property layer

Get or set the AlLocator layer object property.

property name

Get or set the AlLocator name property.

pick(self: alias_api.AlLocator) → int

Pick the locator. This function has not effect if the locator is already picked.

templated(self: alias_api.AlLocator) → int

On successfully checking the locator, return 1 if the AlLocator depends on anoather object which is templated, else return 0. On failure to check, return -1.

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

Return the AlLocator type identifier.

unpick(self: alias_api.AlLocator) → int

Unpick the locator. This function has not effect if the locator is already picked.