alias_api.AlConicAttributes

class alias_api.AlConicAttributes

Bases: AlAttributes

Interface to Alias conic curve attributes.

AlConicAttributes is a class derived from the AlAttributes class. This class allows access to the attributes for a conic section.

Conics may not be created. They may be brought into Alias through the IGES interface though.

A conic is one of ellipse, hyperbola, parabola, circle, or line. Conics exist in the XY plane and are defined by the equation: A * X^2 + B * X * Y + C * Y^2 + D * X + E * Y + F = 0.

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

Returns the center point for a conic.

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

  2. the center point y coordinate

Return type

Tuple[int(AlStatusCode), float, float]

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

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

A * X^2 + B * X * Y + C * Y^2 + D * X + E * Y + F = 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

  5. c_e - the coefficient E

  6. c_f - the coefficient F

Return type

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

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

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

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

This method determines the end point for a conic. Note that for an ellipse the direction of the desired elliptical arc is counterclockwise.

Returns

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

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

  1. the end point x coordinate

  2. the end point y coordinate

Return type

Tuple[int(AlStatusCode), float, float]

form(self: alias_api.AlConicAttributes) → alias_api.AlConicType

Returns the type of the conic (AlConicType).

One of Ellipse, Hyperbola, Parabola, Circle, or Line may be returned. NoConic may be returned if the attribute is no longer active or there is an error.

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

This method determines the start point for a conic. Note that for an ellipse the direction of the desired elliptical arc is counterclockwise.

Returns

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

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

  1. the start point x coordinate

  2. the start point y coordinate

Return type

Tuple[int(AlStatusCode), float, float]

transform(self: alias_api.AlConicAttributes) → tuple[int, alias_api.AlTM]

This method returns the transformation matrix which transforms the 2D conic into 3D.

Returns

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

Success - the transform was successfully returned. InvalidObject - the attribute was invalid. Failure - an eror occured

  1. the resulting transformation matrix

Return type

Tuple[int(AlStatusCode), AlTM]

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

Returns the class identifier ‘ConicAttributeType’.

z_displacement(self: alias_api.AlConicAttributes) → float

This method returns the displacement for the conic along the Z axis.