Displays the included angle between three locators.
Synopsis
#include <AlAngleLocator.h>
class AlAngleLocator : public AlLocator
AlAngleLocator();
virtual ~AlAngleLocator();
virtual AlObject * copyWrapper() const;
virtual AlObjectType type() const;
statusCode create(const AlPointLocator *, const AlPointLocator *, const AlPointLocator *, boolean trueDisplay = TRUE);
AlPointLocator * startLocator() const;
AlPointLocator * middleLocator() const;
AlPointLocator * endLocator() const;
statusCode trueDisplay(boolean &) const;
statusCode setTrueDisplay(boolean);
statusCode offset(double &) const;
statusCode setOffset(double);
statusCode angle(double &) const;
Description
An angle locator is used to find the included angle between any three point locators (AlPointLocator). If any of the three
point locators on which this locator depends is deleted, this locator is deleted. This class contains methods to create the
locator, query the angle, and set the display attributes of the locator in the Alias windows.
AlAngleLocator::AlAngleLocator(void)
Description
Constructs an AlAngleLocator wrapper object.
AlAngleLocator::~AlAngleLocator()
Description
Deletes an AlAngleLocator wrapper object.
AlObject *AlAngleLocator::copyWrapper() const
Description
Returns an exact copy of the AlAngleLocator wrapper.
AlObjectType AlAngleLocator::type() const
Description
Returns the class identifier kAngleLocatorType.
statusCode AlAngleLocator::create(const AlPointLocator *startLocator, const AlPointLocator *middleLocator, const AlPointLocator
*endLocator, boolean trueDisplay)
Description
Creates an angle locator to measure the included angle between three point locators. The measured angle is between the lines
formed by startLocator and middleLocator, and middleLocator and endLocator.
Arguments
< startLocator - the starting point locator
< middleLocator - the middle point locator
< endLocator - the ending point locator
< displayType - determines whether the true value or projection of the true value in the Alias window should be shown. The default is true display.
Return Codes
sSuccess - the angle locator was successfully created
sAlreadyCreated - the object has already been created
sFailure - the angle locator could not be created
sInvalidArgument - one or more of the point locators are not valid
AlPointLocator *AlAngleLocator::startLocator() const
Description
Returns the starting point locator of this angle locator. If the angle locator is not valid, NULL is returned.
AlPointLocator *AlAngleLocator::middleLocator() const
Description
Returns the middle point locator of this angle locator. If the angle locator is not valid, NULL is returned.
AlPointLocator *AlAngleLocator::endLocator() const
Description
Returns the ending point locator of this angle locator. If the angle locator is not valid, NULL is returned.
statusCode AlAngleLocator::trueDisplay(boolean &trueDisplay) const
Description
Determines if the angle locator is depicting the true angle or projected angle in the Alias Modeling windows.
Arguments
> trueDisplay - the value is true if the angle locator displays true angle in a modeling window. It is set to false for a
projected angle.
Return Codes
sSuccess - the display mode was found
sInvalidObject - the locator is not valid
statusCode AlAngleLocator::setTrueDisplay(boolean trueDisplay)
Description
Sets the mode to display the angle locator as either true angle or projected angle in the Modeling window.
Arguments
< trueDisplay - if the value is true then the distance locator displays true distance; if the argument is false, the projected
distance is displayed.
Return Codes
sSuccess - the display mode was set
sInvalidObject - the locator is not valid
statusCode AlAngleLocator::setOffset(double offset)
Description
Sets the offset of the angle locator display.
Arguments
< offset - the offset value
Return Codes
sSuccess - the offset value was set
sInvalidObject - the locator is not valid
statusCode AlAngleLocator::offset(double &offset) const
Description
Finds the offset of the angle locator display.
Arguments
> offset - the offset value
Return Codes
sSuccess - the offset value was found
sInvalidObject - the locator is not valid
statusCode AlAngleLocator::angle(double &includedAngle) const
Description
Finds the angle of the angle locator.
Arguments
> includedAngle - the included angle between the three point locators
Return Codes
sSuccess - the angle was found
sInvalidObject - the locator is not valid
