alias_api.AlRadialLocator

class alias_api.AlRadialLocator

Bases: AlLocator

Interface to Alias Radial locators

A Radial locator is used to create a radial measure of a curve or a curve on surface in their respective parametric spaces. This class methods to create the locator, query the radius and set the display attributes of the radial locator in the Alias windows. If the curve or curve on surface on which this locator is created is deleted, the locator is automatically deleted.

attached_to(self: alias_api.AlRadialLocator) → alias_api.AlObject

Returns the object this locator is attached to. This object can be attached to either a curve on surface or a curve node. NULL is returned if this method fails.

center(self: alias_api.AlRadialLocator) → tuple[int, float, float, float]

Get the center of curvature of the curve where radial locator is created.

Returns

A tuple containing: (1) the status code result of the operation:

Success - the center was found InvalidObject - the object is not valid

  1. the center of curvature of the curve at the locator

Return type

tuple<AlStatusCode, float>

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

Return an exact duplicate of this AlRadialLocator wrapper.

create(*args, **kwargs)

Overloaded function.

  1. create(self: alias_api.AlRadialLocator, curve: alias_api.AlCurve, u: typing.SupportsFloat = 0.0) -> int

    Creates a radial locator on the given curve

    param curve

    The curve on which the locator is created.

    type curve

    AlCurve

    param u

    Curve parameter at which locator is created.

    type u

    float

    return

    The status code result of the operation: Success - the locator was successfully created AlreadyCreated - object has already been created Failure - the radial locator could not be created InvalidArgument - the curve is not a valid object

    rtype

    AlStatusCode

  2. create(self: alias_api.AlRadialLocator, curve: alias_api.AlCurveOnSurface, u: typing.SupportsFloat = 0.0) -> int

    Creates a radial locator on the given curve

    param curve

    The curve on which the locator is created.

    type curve

    AlCurveOnSurface

    param u

    Curve parameter at which locator is created.

    type float

    return

    The status code result of the operation: Success - the locator was successfully created AlreadyCreated - object has already been created Failure - the radial locator could not be created InvalidArgument - the curve is not a valid object

    rtype

    AlStatusCode

diameter_create(self: alias_api.AlRadialLocator, curve: alias_api.AlCurve, u: SupportsFloat = 0.0) → int

Creates a radial locator on the given curve

Parameters

  • curve (AlCurve) – The curve on which which the locator is created.

  • u (float) – The curve parameter at which locator is created.

Returns

The status code result of the operation: Success - the locator was successfully created AlreadyCreated - object has already been created Failure - the radial locator could not be created InvalidArgument - the curve is not a valid object

Return type

AlStatusCode

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

Find whether the text of radial locator is left justified or right justified.

Returns

A tuple containing: (1) the status code result of the operation:

Success - the justification was found InvalidObject - the object is not valid

  1. a boolean value indicating whether the text is left justified

Return type

tuple<AlStatusCode, bool>

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

Get the offset of the Radial locator display.

Parameters

value (float) – The display offset.

Returns

The status code result of the operation: Success - the offset was found InvalidObject - the object is not valid

parameter(self: alias_api.AlRadialLocator) → tuple[int, float]

Get the curve parameter where radial locator is located.

Returns

A tuple containing: (1) the status code result of the operation:

Success - the parameter was found

  1. the curve parameter at the locator

Return type

tuple<AlStatusCode, float>

radius(self: alias_api.AlRadialLocator) → tuple[int, float]

Get the radius of the curve where radial locator is created

Returns

A tuple containing: (1) the status code result of the operation:

Success - the radius was found InvalidObject - the object is not valid

  1. the radius of the curve at the locator

Return type

tuple<AlStatusCode, float>

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

Set the justification of the text for the Radial locator.

The text can be right justified or left justified.

Parameters

left_justify (bool) – A value of true makes the text left justified and a value false makes it right justified.

Returns

The status code result of the operation: Success - setting was successful InvalidObject - the object is not valid

Return type

AlStatusCode

set_offset(self: alias_api.AlRadialLocator, offset: SupportsFloat) → int

Set the offset in Radial locator display.

Parameters

offset (float) – The value of the offset.

Returns

The status code result of the operation: Success - the offset was set InvalidObject - the object is not valid

set_parameter(self: alias_api.AlRadialLocator, u: SupportsFloat) → int

Set the curve parameter at which the radial locator is located.

Parameters

u (float) – The curve parameter

Returns

The status code result of the operation: Success - the parameter was set InvalidObject - the object is not valid

Return type

AlStatusCode

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

Return the AlRadialLocator type identifier.