AlCurveOnSurfaceLocator

Interface to Alias curve on surface locators.

Synopsis

#include <AlCurveOnSurfaceLocator.h>

class AlCurveOnSurfaceLocator : public AlPointLocator

AlCurveOnSurfaceLocator();

virtual ~AlCurveOnSurfaceLocator();

virtual AlObject * copyWrapper() const;

virtual AlObjectType type() const;

statusCode create(const AlCurveOnSurface *, double);

statusCode setParameter(double);

statusCode parameter(double &) const;

virtual statusCode worldPosition(double &, double &, double &) const;

statusCode tangent(double &, double &, double &) const;

statusCode normal1(double &, double &, double &) const;

statusCode normal2(double &, double &, double &) const;

statusCode arcLength(double &) const;

Description

A locator can be created in the parametric space of an AlCurveOnSurface. This locator can be queried for the curve normals, tangent, and position in a world coordinate system. This class contains methods for creating and moving the locator in the parametric space of the curve on surface.

If the AlCurveOnSurface or its AlSurface is deleted, the curve on surface locator created on it is automatically deleted.

Summary

AlCurveOnSurfaceLocator::AlCurveOnSurfaceLocator(void)

Description

Constructs an AlCurveOnSurfaceLocator wrapper object.

AlCurveOnSurfaceLocator::~AlCurveOnSurfaceLocator()

Description

Deletes an AlCurveOnSurfaceLocator wrapper object.

AlObject *AlCurveOnSurfaceLocator::copyWrapper() const

Description

Returns an exact copy of the AlCurveOnSurfaceLocator wrapper.

statusCode AlCurveOnSurfaceLocator::create(const AlCurveOnSurface *curveOnSurface, double u)

Description

Creates a locator on the given curve on surface.

Arguments

curveOnSurface - the curve on surface on which the locator is to be created

u - the parameter at which the locator is to be created

Return Codes

sSuccess - the locator was successfully created

sAlreadyCreated - the object has already been created

sFailure - the locator could not be created on the curve on surface

sInvalidArgument - the curve is not a valid object

statusCode AlCurveOnSurfaceLocator::setParameter(double u)

Description

Moves the position of a locator created on a curve on surface.

Arguments

u - the parameter on the curve on surface to where the locator has to be moved

Return Codes

sSuccess - the locator was moved

sInvalidObject - the locator is not valid

statusCode AlCurveOnSurfaceLocator::parameter(double &u) const

Description

Finds the parameter value at which the locator is present.

Arguments

u - the curve parameter where the locator is present

Return Codes

sSuccess - the parameter was found

sInvalidObject - the locator is not valid

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

Description

Finds the world coordinates of the locator.

Arguments

x, y, z - the world coordinates of the locator

Return Codes

sSuccess - the coordinates were found

sInvalidObject - the locator is not valid

statusCode AlCurveOnSurfaceLocator::tangent(double &x, double &y, double &z) const

Description

Finds the tangent vector to the curve at the point where the locator is present.

Arguments

x, y, z - the x, y, and z components of the tangent

Return Codes

sSuccess - the tangent was found

sInvalidObject - the locator is not valid

statusCode AlCurveOnSurfaceLocator::normal1(double &x, double &y, double &z) const

Description

Finds the normal to the curve on surface at the point where the locator is present.

Arguments

x, y, z - the x, y, and z components of the normal

Return Codes

sSuccess - the normal was found

sInvalidObject - the locator is not valid

statusCode AlCurveOnSurfaceLocator::normal2(double &x, double &y, double &z) const

Description

Finds the second normal to the curve on surface at the point where the locator is present.

Arguments

x, y, z - the x, y, and z components of the second normal vector that has been normalized

Return Codes

sSuccess - the normal was found

sInvalidObject - the locator is not valid

statusCode AlCurveOnSurfaceLocator::arcLength(double &arcLen) const

Description

Finds the length of the curve on surface on which the locator is present.

Arguments

> arcLen - the length of the curve

Return Codes

sSuccess - the arc length was found

sInvalidObject - the locator is not valid

AlObjectType AlCurveOnSurfaceLocator::type() const

Description

Returns the class identifier kCurveOnSurfaceLocatorType.