alias_api.AlConstructionPlane

class alias_api.AlConstructionPlane

Bases: AlConstructionEntity

Interface to Alias construction planes.

This class provides functionality for creating, manipulating and querying Alias construction planes. Construction planes can be specified several ways.

3 Points - The first 2 points specify the X axis. The first and last points specifiy a line that is used in the cross product with the x axis to provide the Z axis. Once the Z is known, the Y axis is calculated internally.

2 points and a normal - The first 2 points specify the X axis. The normal is the Z axis to the plane.

This class provides access to the points used to create the construction plane( end may be NULL depending on the specification), transformation and axes information.

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

Return an exact duplicate of this AlConstructionPlane wrapper.

create(*args, **kwargs)

Overloaded function.

  1. create(self: alias_api.AlConstructionPlane, first: AlPoint, second: AlPoint, third: AlPoint) -> int

    Create a construction plane specified by 3 points. The first 2 points specific the X axis. The first and last point specify a line that is used in the cross product with the X axis to calculate the Z axis.

    return

    The status code result of the operation: Success - the construction plane was created Failure - the method failed InvalidArgument - first, second, or third are either NULL

    or invalid or at least 2 point to the same Alias object

    AlreadyCreated - object is already created

    rtype

    AlStatusCode

  2. create(self: alias_api.AlConstructionPlane, first: AlPoint, second: AlPoint, normal_x: typing.SupportsFloat, normal_y: typing.SupportsFloat, normal_z: typing.SupportsFloat) -> int

    return

    The status code result of the operation: Success - the construction plane was created Failure - the method failed InvalidArgument - first, second, or third are either NULL

    or invalid or at least 2 point to the same Alias object

    AlreadyCreated - object is already created

    rtype

    AlStatusCode

  3. create(self: alias_api.AlConstructionPlane, first_x: typing.SupportsFloat, first_y: typing.SupportsFloat, first_z: typing.SupportsFloat, second_x: typing.SupportsFloat, second_y: typing.SupportsFloat, second_z: typing.SupportsFloat, normal_x: typing.SupportsFloat, normal_y: typing.SupportsFloat, normal_z: typing.SupportsFloat) -> int

    return

    The status code result of the operation: Success - the construction plane was created Failure - the method failed InvalidArgument - first, second, or third are either NULL

    or invalid or at least 2 point to the same Alias object

    AlreadyCreated - object is already created

    rtype

    AlStatusCode

first(self: alias_api.AlConstructionPlane) → AlPoint

Returns the first point of the construction plane.

None is returned if the method failed.

second(self: alias_api.AlConstructionPlane) → AlPoint

Returns the second point of the construction plane.

None is returned if the method failed.

third(self: alias_api.AlConstructionPlane) → AlPoint

Returns the third point of the construction plane.

None is returned if the method failed.

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

Return the AlConstructionPlane type identifier.