Interface
to Alias Radial locators.
Synopsis
#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();
Description
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.
AlRadialLocator::AlRadialLocator(void)
Description
Constructs
an AlRadialLocator wrapper object.
AlRadialLocator::~AlRadialLocator()
Description
Deletes
an AlRadialLocator wrapper object.
AlObject *AlRadialLocator::copyWrapper()
const
Description
Returns an exact copy of the AlRadialLocator
wrapper.
AlObjectType AlRadialLocator::type()
const
Description
Returns
the class identifier kRadialLocatorType.
statusCode AlRadialLocator::create(const
AlCurve *curve, double u)
Description
Creates a radial
locator on the given curve.
Arguments
< curve - the curve
on which the locator is created
< u - curve parameter
at which the locator is created
Return Codes
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
statusCode AlRadialLocator::create(const
AlCurveOnSurface *curve, double u)
Description
Creates
a radial locator on the given curve on surface.
Arguments
< curve - the curve
on surface on which the locator is created
< u - curve parameter
at which the locator is created
Return Codes
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
statusCode AlRadialLocator::radius(double
&radiusValue) const
Description
Gets the radius
of the curve where the radial locator is created.
Arguments
> radius - the radius
of the curve
Return Codes
sSuccess - the radius
was found
sInvalidObject - the
object is not valid
statusCode AlRadialLocator::center(double
&x, double &y, double &z) const
Description
Gets
the center of curvature of the curve where the radial locator is
created.
Arguments
> x, y, z - the world
coordinates of the center
Return Codes
sSuccess - the center
was found
sInvalidObject - the
object is not valid
statusCode AlRadialLocator::setParameter(double
u)
Description
Sets the curve parameter at which
the radial locator is located.
Arguments
< u - curve parameter
Return Codes
sSuccess - the parameter
was set
sInvalidObject - the
object is not valid
statusCode AlRadialLocator::parameter(double
&u) const
Description
Gets the curve parameter
where radial locator is located.
Arguments
> u - curve parameter
Return Codes
sSuccess - the parameter
was found
sInvalidObject - the
object is not valid
statusCode AlRadialLocator::setOffset(double
offset)
Description
Sets the offset in Radial locator
display.
Arguments
< offset - the value
of the offset
Return Codes
sSuccess - the offset
was set
sInvalidObject - the
object is not valid
statusCode AlRadialLocator::offset(double
&offsetValue) const
Description
Gets the offset
of the Radial locator display.
Arguments
> offsetValue - the
display offset
Return Codes
sSuccess - the offset
was found
sInvalidObject - the
object is not valid
statusCode AlRadialLocator::setLeftJustify(boolean
leftJustify)
Description
Sets the justification
of the text for the Radial 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 AlRadialLocator::leftJustify(boolean
&leftJustify) const
Description
Finds whether
the text of radial locator is left justified or right justified.
Arguments
> leftJustify - a
value of true indicates that it is left justified and false indicates
it is right justified.
Return Codes
sSuccess - the justification
was found
sInvalidObject - the
object is not valid
AlObject *AlRadialLocator::attachedTo()
Description
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.
