alias_api.AlAngleLocator

class alias_api.AlAngleLocator

Bases: AlLocator

Displays the included angle between three locators.

An angle locator is used to find the included angle between any three point locators (AlPointLocator). If any of the three point locators on which this locator depends is deleted, this locator is automatically deleted. This class contains methods to create the locator, query the distance, and set the display attributes of the locator in the Alias windows.

angle(self: alias_api.AlAngleLocator) → tuple[int, float]

Find the angle of the locator.

Returns

A tuple containing: (1) the status code result of the operation:

Success - the angle was found InvalidObject - the locator is not valid

  1. The angle of the locator.

Return type

tuple<AlStatusCode, float>

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

Return an exact duplicate of this AlAngleLocator wrapper.

create(self: alias_api.AlAngleLocator, start_point: AlPoint, mid_point: AlPoint, end_point: AlPoint, true_display: SupportsInt = True) → int

Creates an Angle locator to measure the included angle between three point locators. The measured angle is between the lines formed by start_point and mid_point, and mid_point and end_point.

Parameters

  • start_point (AlPoint) – The starting point.

  • mid_point (AlPoint) – The middle point.

  • end_point (AlPoint) – The ending point.

  • display_type (bool) – Whether the true value or projection of the true value in the Alias window should be shown. The default is true display.

Returns

The status code result of the operation: sSuccess - the angle locator was successfully created sAlreadyCreated - object has already been created sFailure - the angle locator could not be created sInvalidArgument - either one or all the given points are not valid.

Return type

AlStatusCode

end_point(self: alias_api.AlAngleLocator) → AlPoint

Returns the ending Point of this Angle locator. However, if the angle locator is not valid, None is returned.

mid_point(self: alias_api.AlAngleLocator) → AlPoint

Returns the middle Point of this Angle locator. However, if the angle locator is not valid, None is returned.

offset(self: alias_api.AlAngleLocator) → tuple[int, float]

Get the offset of the locator display.

Parameters

value (float) – The display offset.

Returns

The status code result of the operation: Success - the offset was found InvalidObject - the object is not valid

set_offset(self: alias_api.AlAngleLocator, offset: SupportsFloat) → int

Set the offset in the locator display.

Parameters

offset (float) – The value of the offset.

Returns

The status code result of the operation: Success - the offset was set InvalidObject - the object is not valid

set_true_display(self: alias_api.AlAngleLocator, value: SupportsInt) → int

Set the display type of this Angle locator. If the angle locator is not valid, None is returned.

set_world_space_offset(self: alias_api.AlAngleLocator, offset: SupportsFloat) → int

Set the offset of the locator in worldspace.

Parameters

offset (float) – The value of the offset.

Returns

The status code result of the operation: Success - the offset was set InvalidObject - the object is not valid

start_point(self: alias_api.AlAngleLocator) → AlPoint

Returns the starting Point of this Angle locator. However, if the angle locator is not valid, None is returned.

true_display(self: alias_api.AlAngleLocator) → tuple[int, int]

Returns 1 if true display is set, else 0.

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

Return the AlAngleLocator type identifier.

world_space_offset(self: alias_api.AlAngleLocator) → tuple[int, float]

Find the offset in the locator in worldspace.

Returns

A tuple containing: (1) the status code result of the operation:

Success - the offset was found InvalidObject - the object is not valid

  1. the offset of the locator in worldspace.

Return type

tuple<AlStatusCode, float>