alias_api.AlPlaneAttributes

class alias_api.AlPlaneAttributes

Bases: AlAttributes

Interface to Alias plane surface attributes.

AlPlaneAttributes is a class derived from the AlAttributes class. This class allows access to the attributes for an plane.

The attributes which define a plane are the coefficients of Ax + By + Cz + D = 0 and coordinates of the center of the plane.

At this time it is only possible to query an AlPlaneAttribute. Further it is currently not possible to create a plane with attributes either in OpenModel or Alias. This attribute is provided for compatibility with IGES, and as such the only way to get a plane with attributes into an Alias wire file is to import an IGES file into Alias and then save a wire file.

center_point(self: alias_api.AlPlaneAttributes) → tuple[int, float, float, float]

Returns the center of a plane

Returns

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

Success - the center point was successfully returned. InvalidObject - the attr

  1. the center point x coordinate

(3) the center point y coordinate (3) the center point z coordinate

Return type

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

coefficients(self: alias_api.AlPlaneAttributes) → tuple[int, float, float, float, float]

Determine the coefficients for the Conic, where the Conic is defined by the equation

Ax + By + Cz + D = 0

Returns

A tuple containg: (1) the status code result:

Success - coefficients were successfully returned. InvalidObject - the attribute was invalid Failure - an error occurred

  1. c_a - the coefficient A

  2. c_b - the coefficient B

  3. c_c - the coefficient C

  4. c_d - the coefficient D

Return type

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

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

This method makes a copy of the AlPlaneAttributes. The returned AlPlaneAttributes will reference the same data as the original.

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

Returns the class identifier ‘ConicAttributeType’.