Ogre Procedural  0.3.0 unstable
Procedural Geometry & Textures for Ogre3D
Public Member Functions | List of all members
Procedural::HelixPath Class Reference

#include <ProceduralSpringGenerator.h>

Public Member Functions

 HelixPath ()
 Default constructor. More...
 
HelixPathsetHeight (Ogre::Real height)
 Sets the height of the helix (default=1.0) More...
 
HelixPathsetRadius (Ogre::Real radius)
 Sets the radius of the helix (default = 1.0) More...
 
HelixPathsetNumRound (Ogre::Real numRound)
 Sets the number of rounds (default = 5.0) More...
 
HelixPathsetNumSegPath (unsigned int numSeg)
 Sets number of segments along the path per turn. More...
 
Path realizePath ()
 Builds a shape from control points. More...
 

Detailed Description

Produces a helix path

Constructor & Destructor Documentation

◆ HelixPath()

Procedural::HelixPath::HelixPath ( )

Default constructor.

Member Function Documentation

◆ realizePath()

Path Procedural::HelixPath::realizePath ( )

Builds a shape from control points.

◆ setHeight()

HelixPath& Procedural::HelixPath::setHeight ( Ogre::Real  height)

Sets the height of the helix (default=1.0)

Exceptions
Ogre::InvalidParametersExceptionHeight must be larger than 0!

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

◆ setNumRound()

HelixPath& Procedural::HelixPath::setNumRound ( Ogre::Real  numRound)

Sets the number of rounds (default = 5.0)

Exceptions
Ogre::InvalidParametersExceptionYou have to rotate more then 0 times!

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

◆ setNumSegPath()

HelixPath& Procedural::HelixPath::setNumSegPath ( unsigned int  numSeg)

Sets number of segments along the path per turn.

Exceptions
Ogre::InvalidParametersExceptionMinimum of numSeg is 1

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

◆ setRadius()

HelixPath& Procedural::HelixPath::setRadius ( Ogre::Real  radius)

Sets the radius of the helix (default = 1.0)

Exceptions
Ogre::InvalidParametersExceptionRadius must be larger than 0!

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


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