alias_api.AlAnnotationLocator

class alias_api.AlAnnotationLocator

Bases: AlLocator

Displays a text string for existing locators

This class creates an annotation to the existing point locators such as a space locator, curve locator, curve on surface locator, and surface locator. An annotation is a line of text and a leader (line with arrow) that is drawn relative to another locator (point type).

To use this locator, create any point locator and attach the annotation string through this locator using the create method. There are also methods to manipulate the position and starting point of the leader line for the annotation.

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

Return an exact duplicate of this AlAnnotationLocator wrapper.

create(self: alias_api.AlAnnotationLocator, start_x: SupportsFloat, start_y: SupportsFloat, start_z: SupportsFloat, string: str, end_x: SupportsFloat, end_y: SupportsFloat, end_z: SupportsFloat) → int

Create a new AlAnnotationLocator in the Alias Universe.

left_justify(self: alias_api.AlAnnotationLocator) → tuple[int, int]

Return the left justify for the annotation locator.

length(self: alias_api.AlAnnotationLocator) → tuple[int, float]

Return the length for the annotation locator.

local_leader_position(self: alias_api.AlAnnotationLocator) → tuple[int, float, float, float]

Return the local leader position for the annotation locator.

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

Return the offset for the annotation locator.

point(self: alias_api.AlAnnotationLocator) → tuple[int, float, float, float]

Return the point for the annotation locator.

set_left_justify(self: alias_api.AlAnnotationLocator, left_justify: SupportsInt) → int

Set the left justify for the annotation locator.

set_length(self: alias_api.AlAnnotationLocator, length: SupportsFloat) → int

Set the length for the annotation locator.

set_local_leader_position(self: alias_api.AlAnnotationLocator, x: SupportsFloat = 0.0, y: SupportsFloat = 0.0, z: SupportsFloat = 0.0) → int

Set the local leader position for the annotation locator.

set_offset(self: alias_api.AlAnnotationLocator, x: SupportsFloat, y: SupportsFloat, z: SupportsFloat) → int

Set the offset for the annotation locator.

set_show_arrow(self: alias_api.AlAnnotationLocator, show: SupportsInt) → int

Set the show arrow for the annotation locator.

set_world_leader_position(self: alias_api.AlAnnotationLocator, x: SupportsFloat = 0.0, y: SupportsFloat = 0.0, z: SupportsFloat = 0.0) → int

Set the world leader position for the annotation locator.

show_arrow(self: alias_api.AlAnnotationLocator) → tuple[int, int]

Return the show arrow for the annotation locator.

property string

Return the AlAnnotationLocator type identifier.

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

Return the AlAnnotationLocator type identifier.

world_leader_position(self: alias_api.AlAnnotationLocator) → tuple[int, float, float, float]

Return the world leader position for the annotation locator.