Castor3D 0.16.0
Multiplatform 3D engine
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
castor3d::SkinComponent Class Reference

#include <SkinComponent.hpp>

Inheritance diagram for castor3d::SkinComponent:
Inheritance graph
[legend]
Collaboration diagram for castor3d::SkinComponent:
Collaboration graph
[legend]

Classes

struct  ComponentData
 
class  Plugin
 

Public Member Functions

C3D_API SkinComponent (Submesh &submesh)
 Constructor.
 
C3D_API SkeletonRPtr getSkeleton () const
 
C3D_API SubmeshComponentUPtr clone (Submesh &submesh) const override
 Clones this component into given submesh.
 
SubmeshComponentFlag getSubmeshFlags () const noexcept override
 
ComponentDatagetData () const noexcept
 
- Public Member Functions inherited from castor3d::SubmeshComponent
C3D_API SubmeshComponent (Submesh &submesh, castor::String const &type, SubmeshComponentDataUPtr data={}, castor::StringArray deps={})
 Constructor.
 
virtual C3D_API ~SubmeshComponent () noexcept=default
 Destructor.
 
virtual C3D_API bool writeText (castor::String const &tabs, castor::Path const &folder, castor::String const &subfolder, castor::StringStream &file) const
 Writes the component content to text.
 
virtual C3D_API void accept (ConfigurationVisitorBase &vis)
 ConfigurationVisitorBase acceptance function.
 
virtual C3D_API ProgramFlags getProgramFlags (Pass const &pass) const noexcept
 
C3D_API void initialiseRenderData ()
 Initialises the render data specific for this component's submesh.
 
castor::String const & getType () const noexcept
 
castor::StringArray const & getDependencies () const noexcept
 
SubmeshComponentPlugin const & getPlugin () const noexcept
 
SubmeshComponentID getId () const noexcept
 
SubmeshComponentDataRPtr getBaseData () const noexcept
 
SubmeshRenderDatagetRenderData () const noexcept
 
template<typename DataT >
DataT * getDataT () const noexcept
 
template<typename DataT >
DataT * getRenderDataT () const noexcept
 
- Public Member Functions inherited from castor::OwnedBy< Submesh >
Submesh * getOwner () const
 

Static Public Member Functions

static SubmeshComponentPluginUPtr createPlugin (SubmeshComponentRegister const &submeshComponents)
 

Static Public Attributes

static C3D_API castor::String const TypeName
 

Additional Inherited Members

- Protected Member Functions inherited from castor::OwnedBy< Submesh >
 OwnedBy (Submesh &owner)
 Constructor.
 
- Protected Attributes inherited from castor3d::SubmeshComponent
SubmeshComponentDataUPtr m_data
 
SubmeshRenderDataPtr m_renderData
 

Constructor & Destructor Documentation

◆ SkinComponent()

C3D_API castor3d::SkinComponent::SkinComponent ( Submesh & submesh)
explicit

Constructor.

Parameters
[in]submeshThe parent submesh.

Member Function Documentation

◆ clone()

C3D_API SubmeshComponentUPtr castor3d::SkinComponent::clone ( Submesh & submesh) const
overridevirtual

Clones this component into given submesh.

Parameters
[in,out]submeshReceives the cloned component.

Implements castor3d::SubmeshComponent.

◆ createPlugin()

static SubmeshComponentPluginUPtr castor3d::SkinComponent::createPlugin ( SubmeshComponentRegister const & submeshComponents)
inlinestatic

◆ getData()

ComponentData & castor3d::SkinComponent::getData ( ) const
inlinenoexcept

◆ getSkeleton()

C3D_API SkeletonRPtr castor3d::SkinComponent::getSkeleton ( ) const
Returns
The skeleton.

◆ getSubmeshFlags()

SubmeshComponentFlag castor3d::SkinComponent::getSubmeshFlags ( ) const
inlineoverridevirtualnoexcept

Returns
The submesh flags.

Reimplemented from castor3d::SubmeshComponent.

References castor3d::SubmeshComponent::getId(), and castor3d::makeSubmeshComponentFlag().

Here is the call graph for this function:

Member Data Documentation

◆ TypeName

C3D_API castor::String const castor3d::SkinComponent::TypeName
static

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