AlLineAttributes

Synopsis

#include <AlLineAttributes.h>

class AlLineAttributes : public AlAttributes

virtual AlObjectType	type() const;

AlObject*	copyWrapper() const;

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

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

statusCode	setStartPoint(double, double, double);

statusCode	setEndPoint(double, double, double);

Description

AlLineAttributes is a class derived from the AlAttributes class. This class allows access to the attributes for a line.

The attributes which define a line are just its start point and its end point. Coordinates are given in object space, and not world space.

AlObjectType AlLineAttributes::type() const

Description

Returns the class identifier ’kLineAttributeType’.

AlObject* AlLineAttributes::copyWrapper() const

Description

Makes a copy of the AlLineAttributes. The returned AlLineAttributes will reference the same data as the original.

statusCode AlLineAttributes::startPoint( double& x, double& y, double& z ) const

Description

Gets the start point for the line.

Arguments

> x, y, z - the returned 3D coordinates of the start point

Return Codes

sSuccess - the start point was successfully returned

sInvalidObject - the attribute was not valid

sFailure - an error occurred.

statusCode AlLineAttributes::endPoint( double& x, double& y, double& z ) const

Description

Gets the end point for the line.

Arguments

> x, y, z - the returned 3D coordinates of the end point

Return Codes

sSuccess - the end point was successfully returned

sInvalidObject - the attribute was not valid

sFailure - an error occurred.

statusCode AlLineAttributes::setStartPoint( double x, double y, double z )

Description

Sets the start point for the line.

Arguments

< x, y, z - the 3D coordinates of the start point

Return Codes

sSuccess - setting the start point succeeded

sFailure - setting the start point failed

sInvalidObject - the attribute was invalid

statusCode AlLineAttributes::setEndPoint( double x, double y, double z )

Description

Sets the end point for the line.

Arguments

< x, y, z - the 3D coordinates of the end point

Return Codes

sSuccess - setting the end point succeeded

sFailure - setting the end point failed

sInvalidObject - the attribute was invalid