alias_api.AlMinmaxLocator

class alias_api.AlMinmaxLocator

Bases: AlLocator

Interface to Alias Min Max locators.

A min max locator finds and displays the minimum and maximum distance between any of the two curves, curves on surface, or surfaces. This class contains methods to create, query the distance and set the display attributes in the Alias windows.

attached_to(self: alias_api.AlMinmaxLocator) → tuple[int, alias_api.AlObject, alias_api.AlObject]

Returns the two objects that are used to create the min/max locator.

The objects returned can be curves on surfaces, curve node or surface nodes.

Returns

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

Success - the attached to objects were found InvalidObject - the object is not valid Failure - the method failed

2. the first object

3. the second object

comb_density(self: alias_api.AlMinmaxLocator) → tuple[int, float]

Finds the density of the comb display for Minmax locator in the Alias modeling windows.

Returns

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

Success - the display mode was found InvalidObject - the object is not valid

2. the comb density

Return type

tuple<AlStatusCode, float>

comb_display(self: alias_api.AlMinmaxLocator) → tuple[int, int]

Whether the comb of the Minmax locator is displayed in the Alias modeling windows.

Returns

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

Success - the display mode was found InvalidObject - the object is not valid

2. the display mode

Return type

tuple<AlStatusCode, bool>

comb_scale(self: alias_api.AlMinmaxLocator) → tuple[int, float]

Finds the scale of the comb display for Minmax locator in the Alias modeling windows.

Returns

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

Success - the display mode was found InvalidObject - the object is not valid

2. the comb scale

Return type

tuple<AlStatusCode, float>

comb_threshold(self: alias_api.AlMinmaxLocator) → tuple[int, float]

Finds the threshold of the comb display for Minmax locator in the Alias modeling windows.

Returns

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

Success - the display mode was found InvalidObject - the object is not valid

2. the comb threshold

Return type

tuple<AlStatusCode, float>

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

Return an exact duplicate of this AlMinmaxLocator wrapper.

create(*args, **kwargs)

Overloaded function.

1. create(self: alias_api.AlMinmaxLocator, curve1: alias_api.AlCurve, curve2: alias_api.AlCurve) -> int

   Create a Minmax locator between two curves.

   param curve1

   The first curve

   type curve1

   AlCurve

   param curve2

   The second curve

   type curve2

   AlCurve

   return

   The status code result of the operation: Success - the minmax locator was created Failure - the minmax locator was not created InvalidArgument - either one or both curves were invalid AlreadyCreated - object has already been created

   rtype

   AlStatusCode

2. create(self: alias_api.AlMinmaxLocator, curve1: alias_api.AlCurve, curve2: alias_api.AlCurveOnSurface) -> int

   Create a Minmax locator between a curve and curve on surface.

   param curve1

   The first curve

   type curve1

   AlCurve

   param curve2

   The second curve on surface

   type curve2

   AlCurveOnSurface

   return

   The status code result of the operation: Success - the minmax locator was created Failure - the minmax locator was not created InvalidArgument - either one or both curves were invalid AlreadyCreated - object has already been created

   rtype

   AlStatusCode

3. create(self: alias_api.AlMinmaxLocator, curve1: alias_api.AlCurveOnSurface, curve2: alias_api.AlCurveOnSurface) -> int

   Create a Minmax locator between two curves on surface.

   param curve1

   The first curve on surface

   type curve1

   AlCurveOnSurface

   param curve2

   The second curve on surface

   type curve2

   AlCurveOnSurface

   return

   The status code result of the operation: Success - the minmax locator was created Failure - the minmax locator was not created InvalidArgument - either one or both curves were invalid AlreadyCreated - object has already been created

   rtype

   AlStatusCode

4. create(self: alias_api.AlMinmaxLocator, curve1: alias_api.AlSurface, curve2: alias_api.AlSurface) -> int

   Create a Minmax locator between two surfaces.

   param curve1

   The first surface

   type curve1

   AlSurface

   param curve2

   The second surface

   type curve2

   AlSurface

   return

   The status code result of the operation: Success - the minmax locator was created Failure - the minmax locator was not created InvalidArgument - either one or both curves were invalid AlreadyCreated - object has already been created

   rtype

   AlStatusCode

5. create(self: alias_api.AlMinmaxLocator, curve1: alias_api.AlCurve, curve2: alias_api.AlSurface) -> int

   Create a Minmax locator between a curve and a surface.

   param curve1

   The first curve

   type curve1

   AlCurve

   param curve2

   The second surface

   type curve2

   AlSurface

   return

   The status code result of the operation: Success - the minmax locator was created Failure - the minmax locator was not created InvalidArgument - either one or both curves were invalid AlreadyCreated - object has already been created

   rtype

   AlStatusCode

6. create(self: alias_api.AlMinmaxLocator, curve1: alias_api.AlCurveOnSurface, curve2: alias_api.AlSurface) -> int

   Create a Minmax locator between a curve on surface and a surface.

   param curve1

   The first curve on surface

   type curve1

   AlCurveOnSurface

   param curve2

   The second surface

   type curve2

   AlSurface

   return

   The status code result of the operation: Success - the minmax locator was created Failure - the minmax locator was not created InvalidArgument - either one or both curves were invalid AlreadyCreated - object has already been created

   rtype

   AlStatusCode

left_justify_max_distance(self: alias_api.AlMinmaxLocator) → tuple[int, int]

Find whether the text of maximum distance in minmax 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

2. the justification

Return type

tuple<AlStatusCode, bool>

left_justify_min_distance(self: alias_api.AlMinmaxLocator) → tuple[int, int]

Find whether the text of minimum distance in minmax 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

2. the justification

Return type

tuple<AlStatusCode, bool>

maximum_distance(self: alias_api.AlMinmaxLocator) → tuple[int, float]

Finds the maximum distance for the Minmax locator

Parameters

dist (float) – The maximum distance

Returns

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

Return type

AlStatusCode

minimum_distance(self: alias_api.AlMinmaxLocator) → tuple[int, float]

Finds the minimum distance for the Minmax locator

Parameters

dist (float) – The minimum distance

Returns

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

Return type

AlStatusCode

set_comb_density(self: alias_api.AlMinmaxLocator, density: SupportsFloat) → int

Set the density of comb in the Alias modeling window for the Minmax locator

Parameters

density (float) – The density of the comb display.

Returns

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

Return type

AlStatusCode

set_comb_display(self: alias_api.AlMinmaxLocator, display: SupportsInt) → int

Set the display of comb in the Alias modeling window for the Minmax locator

Parameters

display (bool) – A value of true sets comb display and false turns the display off.

Returns

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

Return type

AlStatusCode

set_comb_scale(self: alias_api.AlMinmaxLocator, scale: SupportsFloat) → int

Set the scale of comb in the Alias modeling window for the Minmax locator

Parameters

scale (float) – The scale of the comb display.

Returns

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

Return type

AlStatusCode

set_comb_threshold(self: alias_api.AlMinmaxLocator, threshold: SupportsFloat) → int

Set the threshold of comb in the Alias modeling window for the Minmax locator

Parameters

threshold (float) – The threshold of the comb display.

Returns

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

Return type

AlStatusCode

set_left_justify_max_distance(self: alias_api.AlMinmaxLocator, left_justify: SupportsInt) → int

Set the justification of the text for the maximum distance for minmax 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_left_justify_min_distance(self: alias_api.AlMinmaxLocator, left_justify: SupportsInt) → int

Set the justification of the text for the minimum distance for minmax 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

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

Return the AlMinmaxLocator type identifier.