Bookshelf Contents Previous Next Glossary Index Search

AlSpaceLocator

Interface to Alias space locators.

Synopsis

#include <AlSpaceLocator.h>
class AlSpaceLocator : public AlPointLocator
AlSpaceLocator();
~AlSpaceLocator();
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

AlSpaceLocator is the interface to Alias Space Locators. A space locator can be created at any point in the world coordinate system. There are methods to query and modify the position of the locator in this class.

Summary

AlSpaceLocator::AlSpaceLocator(void)

Description

Constructs an AlSpaceLocator wrapper object.

AlSpaceLocator::~AlSpaceLocator()

Description

Deletes an AlSpaceLocator wrapper object.

AlObject *AlSpaceLocator::copyWrapper() const

Description

Returns an exact copy of the AlSpaceLocator wrapper.

AlObjectType AlSpaceLocator::type() const

Description

Returns the class identifier kSpaceLocatorType.

statusCode AlSpaceLocator::create(double x, double y, double z)

Description

Creates a space locator.

Arguments

< x, y, z - the world coordinates of the point at which the space locator is created

Return Codes

sSuccess - the space locator was successfully created

sFailure - failed to create the space locator

sAlreadyCreated - object has already been created

statusCode AlSpaceLocator::setWorldPosition(double x, double y, double z)

Description

Moves a space locator to a new point in world coordinates.

Arguments

< x, y, z - the new coordinates of the space locator

Return Codes

sSuccess - the locator was moved

sInvalidObject - the locator is not valid

statusCode AlSpaceLocator::worldPosition(double &x, double &y, double &z) const

Description

Finds the world coordinates of a space locator.

Arguments

> x, y, z - the X, Y, Z world coordinates of the space locator

Return Codes

sSuccess - the world coordinates were found

sInvalidObject - the locator is not valid



Bookshelf Contents Previous Next Glossary Index Search

[email protected]
Copyright © 1998, Alias|Wavefront, a division of Silicon Graphics Limited. All rights reserved.