#include <ProceduralSpringGenerator.h>
Public Member Functions | |
| HelixPath () | |
| Default constructor. More... | |
| HelixPath & | setHeight (Ogre::Real height) |
| Sets the height of the helix (default=1.0) More... | |
| HelixPath & | setRadius (Ogre::Real radius) |
| Sets the radius of the helix (default = 1.0) More... | |
| HelixPath & | setNumRound (Ogre::Real numRound) |
| Sets the number of rounds (default = 5.0) More... | |
| HelixPath & | setNumSegPath (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::InvalidParametersException Height 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::InvalidParametersException You 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::InvalidParametersException Minimum 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::InvalidParametersException Radius must be larger than 0!
References Ogre::Exception::ERR_INVALIDPARAMS, and OGRE_EXCEPT.
The documentation for this class was generated from the following file:
- ProceduralSpringGenerator.h
