Interface to Alias Radial locators.
#include <AlRadialLocator.h> class AlRadialLocator : public AlLocator AlRadialLocator(); ~AlRadialLocator(); virtual AlObject * copyWrapper() const; virtual AlObjectType type() const; statusCode create(const AlCurve *, double u = 0.0); statusCode create(const AlCurveOnSurface *, double u = 0.0); statusCode radius(double &) const; statusCode center(double &, double &, double &) const; statusCode setParameter(double); statusCode parameter(double &) const; statusCode setOffset(double); statusCode offset(double &) const; statusCode setLeftJustify(boolean); statusCode leftJustify(boolean &) const; AlObject * attachedTo();
A Radial locator is used to create a radial measure of a curve or a curve on surface in its respective parametric space. This class encompasses 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 deleted.
Constructs an AlRadialLocator wrapper object.
Deletes an AlRadialLocator wrapper object.
Returns an exact copy of the AlRadialLocator wrapper.
Returns the class identifier kRadialLocatorType.
Creates a radial locator on the given curve.
< curve - the curve on which the locator is created
< u - curve parameter at which the locator is created
sSuccess - the locator was successfully created
sAlreadyCreated - object has already been created
sFailure - the radial locator could not be created
sInvalidArgument - the curve is not a valid object
Creates a radial locator on the given curve on surface.
< curve - the curve on surface on which the locator is created
< u - curve parameter at which the locator is created
sSuccess - the locator was successfully created
sAlreadyCreated - object has already been created
sFailure - the radial locator could not be created
sInvalidArgument - the given curve on surface is not a valid object
Gets the radius of the curve where the radial locator is created.
> radius - the radius of the curve
sSuccess - the radius was found
sInvalidObject - the object is not valid
Gets the center of curvature of the curve where the radial locator is created.
> x, y, z - the world coordinates of the center
sSuccess - the center was found
sInvalidObject - the object is not valid
Sets the curve parameter at which the radial locator is located.
< u - curve parameter
sSuccess - the parameter was set
sInvalidObject - the object is not valid
Gets the curve parameter where radial locator is located.
> u - curve parameter
sSuccess - the parameter was found
sInvalidObject - the object is not valid
Sets the offset in Radial locator display.
< offset - the value of the offset
sSuccess - the offset was set
sInvalidObject - the object is not valid
Gets the offset of the Radial locator display.
> offsetValue - the display offset
sSuccess - the offset was found
sInvalidObject - the object is not valid
Sets the justification of the text for the Radial locator. The text can be right justified or left justified.
< leftJustify - a value of true makes the text left justified and a value false makes it right justified
sSuccess - setting was successful
sInvalidObject - the object is not valid
Finds whether the text of radial locator is left justified or right justified.
> leftJustify - a value of true indicates that it is left justified and false indicates it is right justified.
sSuccess - the justification was found
sInvalidObject - the object is not valid
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.