Ogre Procedural  0.3.0 unstable
Procedural Geometry & Textures for Ogre3D
Public Member Functions | Protected Attributes | List of all members
Procedural::BaseSpline2< T > Class Template Reference

#include <ProceduralShapeGeneratorsBase.h>

Public Member Functions

 BaseSpline2 ()
 Default constructor. More...
 
T & setOutSide (Side outSide)
 Sets the out side of the shape. More...
 
Side getOutSide () const
 Gets the out side of the shape. More...
 
T & setNumSeg (unsigned int numSeg)
 Sets the number of segments between 2 control points. More...
 
T & close ()
 Closes the spline. More...
 

Protected Attributes

unsigned int mNumSeg
 The number of segments between 2 control points. More...
 
bool mClosed
 Whether the shape will be closed or not. More...
 
Side mOutSide
 The "out" side of the shape. More...
 

Detailed Description

template<class T>
class Procedural::BaseSpline2< T >

Base class for Shape generators

Constructor & Destructor Documentation

◆ BaseSpline2()

template<class T >
Procedural::BaseSpline2< T >::BaseSpline2 ( )

Default constructor.

Member Function Documentation

◆ close()

template<class T >
T& Procedural::BaseSpline2< T >::close ( )

Closes the spline.

◆ getOutSide()

template<class T >
Side Procedural::BaseSpline2< T >::getOutSide ( ) const

Gets the out side of the shape.

◆ setNumSeg()

template<class T >
T& Procedural::BaseSpline2< T >::setNumSeg ( unsigned int  numSeg)

Sets the number of segments between 2 control points.

Exceptions
Ogre::InvalidParametersExceptionMinimum of numSeg is 1

◆ setOutSide()

template<class T >
T& Procedural::BaseSpline2< T >::setOutSide ( Side  outSide)

Sets the out side of the shape.

Member Data Documentation

◆ mClosed

template<class T >
bool Procedural::BaseSpline2< T >::mClosed
protected

Whether the shape will be closed or not.

Referenced by Procedural::BaseSpline2< CatmullRomSpline2 >::close().

◆ mNumSeg

template<class T >
unsigned int Procedural::BaseSpline2< T >::mNumSeg
protected

The number of segments between 2 control points.

Referenced by Procedural::BaseSpline2< CatmullRomSpline2 >::setNumSeg().

◆ mOutSide

template<class T >
Side Procedural::BaseSpline2< T >::mOutSide
protected

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