alias_api.AlLineAttributes

class alias_api.AlLineAttributes

Bases: AlAttributes

Interface to Alias line attributes.

AlLineAttributes is a class derived from the AlAttributes class. This class allows access to the attributes for a line.

The attributes which define a line are just its start point, and its end point. Coordinates are given in object space, and not world space.

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

Return an exact duplicate of this AlLineAttributes wrapper.

end_point(self: alias_api.AlLineAttributes) → tuple[int, float, float, float]

Returns the end point for the line.

Returns

a tuple containing: (1) the status code result:

Success - the start point was successfully returned. InvalidObject - the attribute was invalid. Failure - an error occured

  1. the end point x coordinate

  2. the end point y coordinate

  3. the end point z coordinate

Return type

Tuple[int(AlStatusCode), float, float, float]

set_end_point(self: alias_api.AlLineAttributes, x: SupportsFloat, y: SupportsFloat, z: SupportsFloat) → int

Sets the end point for the line.

Parameters

  • x (float) – end point x coordinate

  • y (float) – end point y coordinate

  • z (float) – end point z coordinate

Returns

the status code result of the operation: Success - Setting the end point succeeded. InvalidObject - the attribute was invalid Failure - Setting the end point failed.

Return type

int(AlStatusCode)

set_start_point(self: alias_api.AlLineAttributes, x: SupportsFloat, y: SupportsFloat, z: SupportsFloat) → int

Sets the start point for the line.

Parameters

  • x (float) – start point x coordinate

  • y (float) – start point y coordinate

  • z (float) – start point z coordinate

Returns

the status code result of the operation: Success - Setting the start point succeeded. InvalidObject - the attribute was not valid Failure - Setting the start point failed.

Return type

int(AlStatusCode)

start_point(self: alias_api.AlLineAttributes) → tuple[int, float, float, float]

Returns the start point for the line.

Returns

a tuple containing: (1) the status code result:

Success - the start point was successfully returned. InvalidObject - the attribute was invalid. Failure - an error occured.

  1. the start point x coordinate

  2. the start point y coordinate

  3. the start point z coordinate

Return type

Tuple[int(AlStatusCode), float, float, float]

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

Return the AlLineAttributes type identifier.