Oriented3DRendererInterface Class Reference
Base Interface for rendering particles that can be oriented in a 3D world. More...
Public Member Functions | |
| Oriented3DRendererInterface () | |
| Constructor of Oriented3DRendererInterface. | |
| virtual | ~Oriented3DRendererInterface () |
| Destructor of Oriented3DRendererInterface. | |
| void | setOrientation (LookOrientation lookOrientation, UpOrientation upOrientation, LockedAxis lockedAxis) |
| Sets the way quads are oriented in the universe. | |
| void | setOrientation (OrientationPreset orientation) |
| Sets the way quads are oriented in the universe. | |
| LookOrientation | getLookOrientation () const |
| Gets the look orientation of the quads. | |
| UpOrientation | getUpOrientation () const |
| Gets the up orientation of the quads. | |
| LockedAxis | getLockedAxis () const |
| Gets the locked axis (the one prevailing over the others). | |
Public Attributes | |
| Vector3D | lookVector |
| The look vector. | |
| Vector3D | upVector |
| The up vector. | |
Detailed Description
Base Interface for rendering particles that can be oriented in a 3D world.
- Since:
- 1.04.00
Definition at line 98 of file SPK_Oriented3DRendererInterface.h.
Constructor & Destructor Documentation
Constructor of Oriented3DRendererInterface.
| virtual ~Oriented3DRendererInterface | ( | ) | [virtual] |
Destructor of Oriented3DRendererInterface.
Definition at line 142 of file SPK_Oriented3DRendererInterface.h.
Member Function Documentation
| LockedAxis getLockedAxis | ( | ) | const |
Gets the locked axis (the one prevailing over the others).
- Returns:
- the locked axis
Definition at line 246 of file SPK_Oriented3DRendererInterface.h.
| LookOrientation getLookOrientation | ( | ) | const |
Gets the look orientation of the quads.
- Returns:
- the look orientation of the quads
Definition at line 236 of file SPK_Oriented3DRendererInterface.h.
| UpOrientation getUpOrientation | ( | ) | const |
Gets the up orientation of the quads.
- Returns:
- the up orientation of the quads
Definition at line 241 of file SPK_Oriented3DRendererInterface.h.
| void setOrientation | ( | OrientationPreset | orientation | ) |
Sets the way quads are oriented in the universe.
This method takes some presets to orientate the quads.
Another method that has more options to configure orientation exists
See setOrientation(LookOrientation,UpOrientation,LockedAxis)
- Parameters:
-
orientation : the orientation preset of the quad
| void setOrientation | ( | LookOrientation | lookOrientation, | |
| UpOrientation | upOrientation, | |||
| LockedAxis | lockedAxis | |||
| ) |
Sets the way quads are oriented in the universe.
This method allows to accuratly configure the orientation of quads.
Another method with only one parameters that take presets exist.
See setOrientation(OrientationPreset)
- Parameters:
-
lookOrientation : The way the look vector of the quad is set upOrientation : The way the up vector of the quad is set lockedAxis : tells which axis prevails over the other
Member Data Documentation
The look vector.
It is used in 2 LookOrientation modes :
- LOOK_AXIS : The look vector is used as the axis
- LOOK_POINT : The look vector is the point quads look to
In other modes the look vector is not used
Definition at line 116 of file SPK_Oriented3DRendererInterface.h.
The up vector.
It is used in 2 UpOrientation modes :
- UP_AXIS : The up axis is used as the axis
- UP_POINT : The up axis is the point quads will be oriented towards
In other modes the up vector is not used
Definition at line 128 of file SPK_Oriented3DRendererInterface.h.
