Interface to Alias space
points.
Synposis
#include <AlSpacePoint.h>
class AlSpacePoint : public AlPoint
AlSpacePoint();
~AlSpacePoint();
virtual AlObject * copyWrapper() const;
virtual AlObjectType type() const;
statusCode create(double x = 0.0, double y = 0.0, double z = 0.0);
statusCode setWorldPosition(double x = 0.0, double y = 0.0, \
double z = 0.0);
virtual statusCode worldPosition(double &, double &, double &) const;
Description
AlSpacePoint is the interface
to Alias Space points. A space point can be created at any
point in the world coordinate system. There are methods to query
and modify the position of the point in this class.
AlSpacePoint::AlSpacePoint(void)
Description
Constructs an AlSpacePoint
wrapper object.
AlSpacePoint::~AlSpacePoint()
Description
Deletes an AlSpacePoint
wrapper object.
AlObject *AlSpacePoint::copyWrapper()
const
Description
Returns an exact copy
of the AlSpacePoint wrapper.
AlObjectType AlSpacePoint::type()
const
Description
Returns the class identifier
kSpacePointType.
statusCode AlSpacePoint::create(double
x, double y, double z)
Description
Create a space point.
Arguments
< x, y, z - the world
coordinates of the point at which the space point is created
Return Codes
sSuccess - The space
point was successfully created.
sFailure - failed to
create the space point
sAlreadyCreated - object
has already been created
statusCode AlSpacePoint::setWorldPosition(double
x, double y, double z)
Description
Move a space point to
a new location in world coordinates.
Arguments
< x, y, z - the new
coordinates of the space point
Return Codes
sSuccess - the point
was moved
sInvalidObject - the
point is not valid
statusCode AlSpacePoint::worldPosition(double
&x, double &y, double &z) const
Description
Find the world coordinates
of a space point
Arguments
> x, y, z - the X,
Y, Z world coordinates of the space point
Return Codes
sSuccess - the world
coordinates were found
sInvalidObject - the
point is not valid
