Radium Engine  1.5.0
Ra::Core::Asset::HandleData Class Reference

#include <Core/Asset/HandleData.hpp>

+ Inheritance diagram for Ra::Core::Asset::HandleData:
+ Collaboration diagram for Ra::Core::Asset::HandleData:

Public Types

enum  HandleType { UNKNOWN = 1 << 0 , POINT_CLOUD = 1 << 1 , SKELETON = 1 << 2 , CAGE = 1 << 3 }
 

Public Member Functions

 HandleData (const std::string &name="", const HandleType &type=UNKNOWN)
 
 HandleData (const HandleData &data)=default
 
uint getVertexSize () const
 
void setVertexSize (uint size)
 
void setNameTable (const std::map< std::string, uint > &nameTable)
 
void recomputeAllIndices ()
 
void displayInfo () const
 
HandleArray
void setName (const std::string &name)
 
HandleType getType () const
 
void setType (const HandleType &type)
 
Core::Transform getFrame () const
 
void setFrame (const Core::Transform &frame)
 
void addBindMesh (const std::string &name)
 
const std::set< std::string > & getBindMeshes () const
 
Data access
uint getComponentDataSize () const
 
const Core::AlignedStdVector< HandleComponentData > & getComponentData () const
 
Core::AlignedStdVector< HandleComponentData > & getComponentData ()
 
const HandleComponentDatagetComponent (const uint i) const
 
HandleComponentDatagetComponent (const uint i)
 
void setComponents (const Core::AlignedStdVector< HandleComponentData > &components)
 
const Core::AlignedStdVector< Core::Vector2ui > & getEdgeData () const
 
Core::AlignedStdVector< Core::Vector2ui > & getEdgeData ()
 
void setEdges (const Core::AlignedStdVector< Core::Vector2ui > &edgeList)
 
const Core::AlignedStdVector< Core::VectorNui > & getFaceData () const
 
Core::AlignedStdVector< Core::VectorNui > & getFaceData ()
 
void setFaces (const Core::AlignedStdVector< Core::VectorNui > &faceList)
 
void needEndNodes (bool need)
 
Status querries
bool isPointCloud () const
 
bool isSkeleton () const
 
bool isCage () const
 
bool hasComponents () const
 
bool hasEdges () const
 
bool hasFaces () const
 
bool needsEndNodes () const
 
int getIndexOf (const std::string &name) const
 
- Public Member Functions inherited from Ra::Core::Asset::AssetData
 AssetData (const std::string &name)
 Construct an asset data given its name.
 
 AssetData (const AssetData &other)=default
 Copy constructor. Default here.
 
virtual ~AssetData ()
 Simple delete operator.
 
virtual const std::string & getName () const
 Acces to the name of the asset.
 

Additional Inherited Members

- Protected Attributes inherited from Ra::Core::Asset::AssetData
std::string m_name
 

Detailed Description

The HandleData class stores all the HandleComponentData linked to an object.

Definition at line 42 of file HandleData.hpp.

Member Enumeration Documentation

◆ HandleType

The type of Handle system.

Definition at line 50 of file HandleData.hpp.

Member Function Documentation

◆ addBindMesh()

void Ra::Core::Asset::HandleData::addBindMesh ( const std::string &  name)
inline

Add name to the list of bound mesh names.

Definition at line 407 of file HandleData.hpp.

◆ displayInfo()

void Ra::Core::Asset::HandleData::displayInfo ( ) const
inline

Print stat info to the Debug output.

Definition at line 415 of file HandleData.hpp.

◆ getBindMeshes()

const std::set< std::string > & Ra::Core::Asset::HandleData::getBindMeshes ( ) const
inline

Returns the list of bound mesh names.

Definition at line 411 of file HandleData.hpp.

◆ getComponent() [1/2]

HandleComponentData & Ra::Core::Asset::HandleData::getComponent ( const uint  i)
inline

Return the i-th HandleComponentData.

Definition at line 323 of file HandleData.hpp.

◆ getComponent() [2/2]

const HandleComponentData & Ra::Core::Asset::HandleData::getComponent ( const uint  i) const
inline

Return the i-th HandleComponentData.

Definition at line 318 of file HandleData.hpp.

◆ getComponentData() [1/2]

Core::AlignedStdVector< HandleComponentData > & Ra::Core::Asset::HandleData::getComponentData ( )
inline

Return the list of HandleComponentData.

Definition at line 304 of file HandleData.hpp.

◆ getComponentData() [2/2]

const Core::AlignedStdVector< HandleComponentData > & Ra::Core::Asset::HandleData::getComponentData ( ) const
inline

Return the list of HandleComponentData.

Definition at line 300 of file HandleData.hpp.

◆ getComponentDataSize()

uint Ra::Core::Asset::HandleData::getComponentDataSize ( ) const
inline

Return the number of Handles in the system.

Definition at line 296 of file HandleData.hpp.

◆ getEdgeData() [1/2]

Core::AlignedStdVector< Core::Vector2ui > & Ra::Core::Asset::HandleData::getEdgeData ( )
inline

Return the HandleArray hierarchy, i.e. bones hierarchy.

Definition at line 332 of file HandleData.hpp.

◆ getEdgeData() [2/2]

const Core::AlignedStdVector< Core::Vector2ui > & Ra::Core::Asset::HandleData::getEdgeData ( ) const
inline

Return the HandleArray hierarchy, i.e. bones hierarchy.

Definition at line 328 of file HandleData.hpp.

◆ getFaceData() [1/2]

Core::AlignedStdVector< Core::VectorNui > & Ra::Core::Asset::HandleData::getFaceData ( )
inline

Return the HandleArray N-Dimensional parts, i.e. cage polyhedra.

Definition at line 349 of file HandleData.hpp.

◆ getFaceData() [2/2]

const Core::AlignedStdVector< Core::VectorNui > & Ra::Core::Asset::HandleData::getFaceData ( ) const
inline

Return the HandleArray N-Dimensional parts, i.e. cage polyhedra.

Definition at line 345 of file HandleData.hpp.

◆ getFrame()

Core::Transform Ra::Core::Asset::HandleData::getFrame ( ) const
inline

Return the transformation of the Handle system.

Definition at line 277 of file HandleData.hpp.

◆ getIndexOf()

int Ra::Core::Asset::HandleData::getIndexOf ( const std::string &  name) const
inline

Return the storage index of the Handle with the given name if it exists, -1 otherwise.

Definition at line 397 of file HandleData.hpp.

◆ getType()

HandleData::HandleType Ra::Core::Asset::HandleData::getType ( ) const
inline

Return the type of the Handle system.

Definition at line 269 of file HandleData.hpp.

◆ getVertexSize()

uint Ra::Core::Asset::HandleData::getVertexSize ( ) const
inline

Return the maximal number of vertices influenced by a Handle.

Definition at line 285 of file HandleData.hpp.

◆ hasComponents()

bool Ra::Core::Asset::HandleData::hasComponents ( ) const
inline

Return true if the Handle system has Handles.

Definition at line 381 of file HandleData.hpp.

◆ hasEdges()

bool Ra::Core::Asset::HandleData::hasEdges ( ) const
inline

Return true if the Handle system has a hierarchy.

Definition at line 385 of file HandleData.hpp.

◆ hasFaces()

bool Ra::Core::Asset::HandleData::hasFaces ( ) const
inline

Return true if the Handle system has N-Dimensional parts.

Definition at line 389 of file HandleData.hpp.

◆ isCage()

bool Ra::Core::Asset::HandleData::isCage ( ) const
inline

Return true if the Handle system is a Cage.

Definition at line 377 of file HandleData.hpp.

◆ isPointCloud()

bool Ra::Core::Asset::HandleData::isPointCloud ( ) const
inline

Return true if the Handle system is a Point Cloud.

Definition at line 369 of file HandleData.hpp.

◆ isSkeleton()

bool Ra::Core::Asset::HandleData::isSkeleton ( ) const
inline

Return true if the Handle system is a Skeleton.

Definition at line 373 of file HandleData.hpp.

◆ needEndNodes()

void Ra::Core::Asset::HandleData::needEndNodes ( bool  need)
inline

Set whether the Handle system needs end bones.

Definition at line 403 of file HandleData.hpp.

◆ needsEndNodes()

bool Ra::Core::Asset::HandleData::needsEndNodes ( ) const
inline

Return true if the Handle system needs end bones.

Definition at line 393 of file HandleData.hpp.

◆ recomputeAllIndices()

void Ra::Core::Asset::HandleData::recomputeAllIndices ( )
inline

Recompute the map from Handle names to Handle storage index.

Definition at line 362 of file HandleData.hpp.

+ Here is the call graph for this function:

◆ setComponents()

void Ra::Core::Asset::HandleData::setComponents ( const Core::AlignedStdVector< HandleComponentData > &  components)
inline

Set the HandleComponentData for the Handle system.

Definition at line 309 of file HandleData.hpp.

◆ setEdges()

void Ra::Core::Asset::HandleData::setEdges ( const Core::AlignedStdVector< Core::Vector2ui > &  edgeList)
inline

Set the HandleArray linear hierarchy part, i.e. bones hierarchy.

Definition at line 336 of file HandleData.hpp.

◆ setFaces()

void Ra::Core::Asset::HandleData::setFaces ( const Core::AlignedStdVector< Core::VectorNui > &  faceList)
inline

Set the HandleArray N-Dimensional parts, i.e. cage polyhedra.

Definition at line 353 of file HandleData.hpp.

◆ setFrame()

void Ra::Core::Asset::HandleData::setFrame ( const Core::Transform &  frame)
inline

Set the transformation of the Handle system.

Definition at line 281 of file HandleData.hpp.

◆ setName()

void Ra::Core::Asset::HandleData::setName ( const std::string &  name)
inline

Set the name of the Handle system.

Definition at line 265 of file HandleData.hpp.

◆ setNameTable()

void Ra::Core::Asset::HandleData::setNameTable ( const std::map< std::string, uint > &  nameTable)
inline

Set the map from Handle names to Handle storage index.

Definition at line 292 of file HandleData.hpp.

◆ setType()

void Ra::Core::Asset::HandleData::setType ( const HandleType type)
inline

Set the type of the Handle system.

Definition at line 273 of file HandleData.hpp.

◆ setVertexSize()

void Ra::Core::Asset::HandleData::setVertexSize ( uint  size)
inline

Set the maximal number of vertices influenced by a Handle.

Definition at line 288 of file HandleData.hpp.


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