Procedural::LinePath Class Reference

Builds a line Path between 2 points. More...

#include <ProceduralPathGenerators.h>

Public Member Functions
	LinePath ()
	Default constructor. More...
LinePath &	setPoint1 (Ogre::Vector3 point1)
	Sets first point. More...
LinePath &	setPoint2 (Ogre::Vector3 point2)
	Sets second point. More...
LinePath &	setNumSeg (unsigned int numSeg)
	Sets the number of segments for this line. More...
LinePath &	betweenPoints (Ogre::Vector3 point1, Ogre::Vector3 point2)
	Builds a linepath between 2 points. More...
Path	realizePath ()
	Outputs a path. More...

Detailed Description

Builds a line Path between 2 points.

Constructor & Destructor Documentation

LinePath()

Procedural::LinePath::LinePath

(

)

Default constructor.

Member Function Documentation

betweenPoints()

LinePath& Procedural::LinePath::betweenPoints	(	Ogre::Vector3	point1,
		Ogre::Vector3	point2
	)

Builds a linepath between 2 points.

realizePath()

Path Procedural::LinePath::realizePath

(

)

Outputs a path.

References Procedural::Path::addPoint().

setNumSeg()

LinePath& Procedural::LinePath::setNumSeg

(

unsigned int

numSeg

)

Sets the number of segments for this line.

Exceptions

Ogre::InvalidParametersException

Minimum of numSeg is 1

References Ogre::Exception::ERR_INVALIDPARAMS, and OGRE_EXCEPT.

setPoint1()

LinePath& Procedural::LinePath::setPoint1

(

Ogre::Vector3

point1

)

Sets first point.

setPoint2()

LinePath& Procedural::LinePath::setPoint2

(

Ogre::Vector3

point2

)

Sets second point.

---

The documentation for this class was generated from the following file:

• ProceduralPathGenerators.h