An interface to Alias Min Max locators.
Synopsis
#include <AlMinmaxLocator.h>
class AlMinmaxLocator : public AlLocator
AlMinmaxLocator();
virtual ~AlMinmaxLocator();
virtual AlObject * copyWrapper() const;
virtual AlObjectType type() const;
statusCode create(const AlCurve *, const AlCurve *);
statusCode create(const AlCurve *, const AlCurveOnSurface *);
statusCode create(const AlCurveOnSurface *, const AlCurveOnSurface *);
statusCode create(const AlSurface *, const AlSurface *);
statusCode create(const AlCurve *, const AlSurface *);
statusCode create(const AlCurveOnSurface *, const AlSurface *);
statusCode setCombDisplay (boolean) ;
statusCode combDisplay (boolean &) const;
statusCode setCombScale (double) ;
statusCode combScale (double &) const;
statusCode setCombThreshold (double) ;
statusCode combThreshold (double &) const;
statusCode setCombDensity (double) ;
statusCode combDensity (double &) const;
statusCode minimumDistance (double &) const;
statusCode maximumDistance (double &) const;
statusCode setLeftJustifyMinDistance(boolean);
statusCode leftJustifyMinDistance(boolean &) const;
statusCode setLeftJustifyMaxDistance(boolean);
statusCode leftJustifyMaxDistance(boolean &) const;
statusCode attachedTo( AlObject *&, AlObject *& );
Description
A min max locator finds and displays the minimum and maximum distance between any two of: curves, curves on surface, or surfaces.
This class contains methods to create, query the distance and set the display attributes in the Alias windows.
AlMinmaxLocator::AlMinmaxLocator(void)
Description
Constructs an AlMinmaxLocator wrapper object.
AlMinmaxLocator::~AlMinmaxLocator()
Description
Deletes an AlMinmaxLocator wrapper object.
AlObject *AlMinmaxLocator::copyWrapper() const
Description
Returns an exact copy of the AlMinmax wrapper.
AlObjectType AlMinmaxLocator::type() const
Description
Returns the class identifier kMinmaxLocatorType.
statusCode AlMinmaxLocator::create(const AlCurve *curve1, const AlCurve *curve2)
Description
Creates a Minmax locator between two curves.
Arguments
< curve1 - the first curve
< curve2 - the second curve
Return Codes
sSuccess - the minmax locator was created
sFailure - the minmax locator was not created
sInvalidArgument - either one or both curves were invalid
sAlreadyCreated - object has already been created
statusCode AlMinmaxLocator::create(const AlCurveOnSurface *curve1, const AlCurveOnSurface *curve2)
Description
Creates a Minmax locator between two curves on surface.
Arguments
< curve1 - the first curve on surface
< curve2 - the second curve on surface
Return Codes
sSuccess - the minmax locator was created
sFailure - the minmax locator was not created
sInvalidArgument - either one or both curves on surface were invalid
sAlreadyCreated - object has already been created
statusCode AlMinmaxLocator::create(const AlCurve *curve1, const AlCurveOnSurface *curve2)
Description
Creates a Minmax locator between a curve and a curve on surface.
Arguments
< curve1 - the first curve
< curve2 - the second curve on surface
Return Codes
sSuccess - the minmax locator was created
sFailure - the minmax locator was not created
sInvalidArgument - either one or both curves were invalid
sAlreadyCreated - object has already been created
statusCode AlMinmaxLocator::create(const AlSurface *surface1, const AlSurface *surface2)
Description
Creates a Minmax locator between two surfaces.
Arguments
< surface1 - the first surface
< surface2 - the second surface
Return Codes
sSuccess - the minmax locator was created
sFailure - the minmax locator was not created
sInvalidArgument - either one or both surfaces were invalid
sAlreadyCreated - object has already been created
statusCode AlMinmaxLocator::create(const AlCurve *curve1, const AlSurface *surface2)
Description
Creates a Minmax locator between a curve and a surface.
Arguments
< curve1 - the first curve
< surface2 - the second surface
Return Codes
sSuccess - the minmax locator was created
sFailure - the minmax locator was not created
sInvalidArgument - either one or both curves or surfaces were invalid
sAlreadyCreated - object has already been created
statusCode AlMinmaxLocator::create(const AlCurveOnSurface *curve1, const AlSurface *surface2)
Description
Creates a Minmax locator between a curve on surface and a surface.
Arguments
< curve1 - the first curve on surface
< surface2 - the second surface
Return Codes
sSuccess - the minmax locator was created
sFailure - the minmax locator was not created
sInvalidArgument - either one or both curves or surfaces were invalid
sAlreadyCreated - object has already been created
statusCode AlMinmaxLocator::setCombDisplay(boolean display)
Description
Sets the display of comb in the Alias modeling window for the Minmax locator.
Arguments
< display - a value of true sets comb display and false turns the display off
Return Codes
sSuccess - the display mode was set successfully
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::combDisplay(boolean &display) const
Description
Determines whether the comb of the Minmax locator is displayed in the Alias modeling windows.
Arguments
> display - it is true if the comb is displayed, false otherwise
Return Codes
sSuccess - the display mode was found
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::setCombScale(double scale)
Description
Sets the scale of the comb display for Minmax locator in the Alias modeling window.
Arguments
< scale - the scale of the comb display
Return Codes
sSuccess - the scale of the comb was set successfully
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::combScale(double &scale) const
Description
Finds the scale of the comb display for Minmax locator in the Alias modeling windows.
Arguments
> scale - the scale of the comb display
Return Codes
sSuccess - the comb scale was found
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::setCombThreshold(double threshold)
Description
Sets the threshold of the comb display for Minmax locator in the Alias modeling window.
Arguments
< threshold - the threshold of the comb display
Return Codes
sSuccess - the threshold of the comb was set successfully
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::combThreshold(double &threshold) const
Description
Finds the threshold of the comb display for Minmax locator in the Alias modeling windows.
Arguments
> threshold - the threshold of the comb display
Return Codes
sSuccess - the comb threshold was found
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::setCombDensity(double density)
Description
Sets the density of the comb display for Minmax locator in the Alias modeling window.
Arguments
< density - the density of the comb display
Return Codes
sSuccess - the density of the comb was set successfully
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::combDensity(double &density) const
Description
Finds the density of the comb display for Minmax locator in the Alias modeling windows.
Arguments
> density - the density of the comb display
Return Codes
sSuccess - the comb density was found
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::minimumDistance(double &dist) const
Description
Finds the minimum distance for the Minmax locator.
Arguments
> dist - the minimum distance
Return Codes
sSuccess - the minimum distance was found
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::maximumDistance(double &dist) const
Description
Finds the maximum distance for the Minmax locator.
Arguments
> dist - the maximum distance
Return Codes
sSuccess - the maximum distance was found
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::setLeftJustifyMinDistance(boolean leftJustify)
Description
Sets the justification of the text for the minimum distance for minmax locator. The text can be right justified or left justified.
Arguments
< leftJustify - a value of true makes the text left justified and a value false makes it right justified
Return Codes
sSuccess - setting was successful
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::leftJustifyMinDistance(boolean &leftJustify) const
Description
Finds whether the text of minimum distance in minmax locator is left justified or right justified.
Arguments
> leftJustify - a value of true indicates that it is left justified and false indicates that it is right justified.
Return Codes
sSuccess - the justification was found
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::setLeftJustifyMaxDistance(boolean leftJustify)
Description
Sets the justification of the text for the maximum distance for minmax locator. The text can be right justified or left justified.
Arguments
< leftJustify - a value of true makes the text left justified and a value false makes it right justified
Return Codes
sSuccess - setting was successful
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::leftJustifyMaxDistance(boolean &leftJustify) const
Description
Finds whether the text of maximum distance in minmax locator is left justified or right justified.
Arguments
> leftJustify - a value of true indicates that it is left justified and false indicates that it is right justified
Return Codes
sSuccess - the justification was found
sInvalidObject - the object is not valid
statusCode AlMinmaxLocator::attachedTo( AlObject *& objectOne, AlObject *& objectTwo )
Description
Returns the objects that are used to create the min/max locator. The objects returned can be curves on surfaces, curve nodes
or surface nodes.
Arguments
> objectOne, objectTwo - attached to objects
Return Codes
sSuccess - the attached to objects were found
sInvalidObject - the object is not valid
sFailure - the method failed
