This class gives access to the spatial aspect of an object (layer, point, etc). More...
Inheritance diagram for VgEngine::VgSpatial:
Collaboration diagram for VgEngine::VgSpatial:
Public Member Functions | |
| void | setAnimation (VgEngine::VgRefPtr< VgEngine::VgAnimation > pAnimation) |
| Sets an animation on this spatial. | |
| VgEngine::VgPosition | getPosition () const |
| Gets spatial's position. | |
| void | setPosition (const VgEngine::VgPosition &pPosition, bool pHaveGeographicCoherence=true) |
| Sets the spatial position. | |
Protected Member Functions | |
| VgSpatial () | |
| Default constructor. | |
| virtual | ~VgSpatial () |
| Destructor. | |
Protected Attributes | |
| Private * | mPrivate |
| Private. | |
Friends | |
| class | VgObjectBridge |
| class | VgLayer |
Detailed Description
This class gives access to the spatial aspect of an object (layer, point, etc).
The spatial aspect controls the object's position in scene space. It also enables animation features on spatial objects.
- Version:
- 2.0
Constructor & Destructor Documentation
| VgEngine::VgSpatial::VgSpatial | ( | ) | [protected] |
Default constructor.
This is protected since it is not possible to create a spatial directly. Instead, instantiate a spatial object (like point for example) and access it's spatial aspect.
| virtual VgEngine::VgSpatial::~VgSpatial | ( | ) | [protected, virtual] |
Destructor.
Member Function Documentation
| VgEngine::VgPosition VgEngine::VgSpatial::getPosition | ( | ) | const |
Gets spatial's position.
- Returns:
- The spatial's poisition.
| void VgEngine::VgSpatial::setAnimation | ( | VgEngine::VgRefPtr< VgEngine::VgAnimation > | pAnimation ) |
Sets an animation on this spatial.
- Parameters:
-
pAnimation The animation to animate the spatial with.
| void VgEngine::VgSpatial::setPosition | ( | const VgEngine::VgPosition & | pPosition, |
| bool | pHaveGeographicCoherence = true |
||
| ) |
Sets the spatial position.
- Parameters:
-
pPosition The position to put the spatial at. pHaveGeographicCoherence An optional parameter who by default is true. Is used to determine the geographic coherence of the spatial. If set to false, then the spatial will be coherent with the scene.
Friends And Related Function Documentation
friend class VgLayer [friend] |
friend class VgObjectBridge [friend] |
Reimplemented in VgEngine::VgLayer.
Member Data Documentation
Private* VgEngine::VgSpatial::mPrivate [protected] |
Private.
The documentation for this class was generated from the following file:
- VgSpatial.h