Castor3D  ..
Public Member Functions | List of all members
Castor3D::AnimatedObjectGroupManager Class Reference

AnimatedObjectGroup manager. More...

+ Inheritance diagram for Castor3D::AnimatedObjectGroupManager:
+ Collaboration diagram for Castor3D::AnimatedObjectGroupManager:

Public Member Functions

C3D_API AnimatedObjectGroupManager (Scene &p_owner, SceneNodeSPtr p_rootNode, SceneNodeSPtr p_rootCameraNode, SceneNodeSPtr p_rootObjectNode)
 Constructor. More...
 
C3D_API ~AnimatedObjectGroupManager ()
 Destructor. More...
 
C3D_API void Update ()
 Updates currently playing animations in animated objects. More...
 
template<typename ... Parameters>
std::shared_ptr< AnimatedObjectGroupCreate (Castor::String const &p_name, Parameters &&... p_params)
 Creates an object from a name. More...
 
- Public Member Functions inherited from Castor3D::ObjectManager< Castor::String, AnimatedObjectGroup >
EngineGetEngine () const
 
void Cleanup ()
 Sets all the elements to be cleaned up. More...
 
void Remove (Castor::String const &p_name)
 Removes an object, given a name. More...
 
void MergeInto (ObjectManager< Castor::String, AnimatedObjectGroup > &p_destination)
 
std::shared_ptr< AnimatedObjectGroupCreate (Castor::String const &p_name, SceneNodeSPtr p_parent=nullptr, Parameters &&... p_params)
 Creates an object. More...
 
uint32_t GetObjectCount () const
 
- Public Member Functions inherited from Castor3D::Manager< Castor::String, AnimatedObjectGroup, Scene, ObjectManagerEngineGetter >
void Cleanup ()
 Sets all the elements to be cleaned up. More...
 
void Clear ()
 Flushes the collection. More...
 
bool IsEmpty ()
 
void Insert (Castor::String const &p_name, std::shared_ptr< AnimatedObjectGroup > p_element)
 Removes an object, given a name. More...
 
void Remove (Castor::String const &p_name)
 Removes an object, given a name. More...
 
void SetRenderSystem (RenderSystem *p_renderSystem)
 
RenderSystemSetRenderSystem () const
 
EngineGetEngine () const
 
Castor::String const & GetObjectTypeName () const
 
bool Has (Castor::String const &p_name) const
 
std::shared_ptr< AnimatedObjectGroupFind (Castor::String const &p_name) const
 Looks for an element with given name. More...
 
void lock () const
 Locks the collection mutex. More...
 
void unlock () const
 Unlocks the collection mutex. More...
 
Collection::TObjPtrMapIt begin ()
 Returns an iterator to the first element of the collection. More...
 
Collection::TObjPtrMapConstIt begin () const
 Returns an constant iterator to the first element of the collection. More...
 
Collection::TObjPtrMapIt end ()
 Returns an iterator to the after last element of the collection. More...
 
Collection::TObjPtrMapConstIt end () const
 Returns an constant iterator to the after last element of the collection. More...
 
std::shared_ptr< AnimatedObjectGroupCreate (Castor::String const &p_name, Parameters &&... p_params)
 Creates an object. More...
 

Additional Inherited Members

- Public Types inherited from Castor3D::Manager< Castor::String, AnimatedObjectGroup, Scene, ObjectManagerEngineGetter >
typedef Castor::Collection< AnimatedObjectGroup, Castor::String > Collection
 
- Protected Member Functions inherited from Castor3D::ObjectManager< Castor::String, AnimatedObjectGroup >
 ObjectManager (Scene &p_owner, SceneNodeSPtr p_rootNode, SceneNodeSPtr p_rootCameraNode, SceneNodeSPtr p_rootObjectNode)
 Constructor. More...
 
 ~ObjectManager ()
 Destructor. More...
 
- Protected Member Functions inherited from Castor3D::Manager< Castor::String, AnimatedObjectGroup, Scene, ObjectManagerEngineGetter >
 Manager (Scene &p_owner)
 Constructor. More...
 
 ~Manager ()
 Destructor. More...
 
- Protected Attributes inherited from Castor3D::ObjectManager< Castor::String, AnimatedObjectGroup >
SceneNodeWPtr m_rootNode
 The root node. More...
 
SceneNodeWPtr m_rootCameraNode
 The root node used only for cameras (used to ease the use of cameras) More...
 
SceneNodeWPtr m_rootObjectNode
 The root node for every object other than camera (used to ease the use of cameras) More...
 
- Protected Attributes inherited from Castor3D::Manager< Castor::String, AnimatedObjectGroup, Scene, ObjectManagerEngineGetter >
RenderSystemm_renderSystem
 The RenderSystem. More...
 
Collection m_elements
 The elements collection. More...
 

Detailed Description

AnimatedObjectGroup manager.

Author
Sylvain DOREMUS
Date
29/01/2016
Version
0.8.0

Constructor & Destructor Documentation

◆ AnimatedObjectGroupManager()

C3D_API Castor3D::AnimatedObjectGroupManager::AnimatedObjectGroupManager ( Scene p_owner,
SceneNodeSPtr  p_rootNode,
SceneNodeSPtr  p_rootCameraNode,
SceneNodeSPtr  p_rootObjectNode 
)

Constructor.

Parameters
[in]p_ownerThe owner.
[in]p_rootNodeThe root node.
[in]p_rootCameraNodeThe cameras root node.
[in]p_rootObjectNodeThe objects root node.

◆ ~AnimatedObjectGroupManager()

C3D_API Castor3D::AnimatedObjectGroupManager::~AnimatedObjectGroupManager ( )

Destructor.

Member Function Documentation

◆ Create()

template<typename ... Parameters>
std::shared_ptr< AnimatedObjectGroup > Castor3D::AnimatedObjectGroupManager::Create ( Castor::String const &  p_name,
Parameters &&...  p_params 
)
inline

Creates an object from a name.

Parameters
[in]p_nameThe object name.
[in]p_paramsThe other constructor parameters.
Returns
The created object.

References Castor3D::Manager< Castor::String, AnimatedObjectGroup, Scene, ObjectManagerEngineGetter >::GetObjectTypeName(), Castor3D::INFO_MANAGER_CREATED_OBJECT, Castor3D::Manager< Castor::String, AnimatedObjectGroup, Scene, ObjectManagerEngineGetter >::m_elements, and Castor3D::WARNING_MANAGER_DUPLICATE_OBJECT.

+ Here is the call graph for this function:

◆ Update()

C3D_API void Castor3D::AnimatedObjectGroupManager::Update ( )

Updates currently playing animations in animated objects.


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