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

Divider Plugin class. More...

+ Inheritance diagram for Castor3D::DividerPlugin:
+ Collaboration diagram for Castor3D::DividerPlugin:

Public Member Functions

C3D_API DividerPlugin (Castor::DynamicLibrarySPtr p_library, Engine *p_engine)
 Constructor. More...
 
virtual C3D_API ~DividerPlugin ()
 Destructor. More...
 
C3D_API SubdividerCreateDivider ()
 Creates the Subdivider. More...
 
C3D_API void DestroyDivider (Subdivider *p_pDivider)
 Destroys the given Subdivider. More...
 
C3D_API Castor::String GetDividerType ()
 Tells the divider short name. More...
 
- Public Member Functions inherited from Castor3D::PluginBase
virtual C3D_API ~PluginBase ()=0
 Destructor. More...
 
C3D_API void GetRequiredVersion (Version &p_version) const
 Retrieves the required version for the plug-in to work correctly. More...
 
C3D_API Castor::String GetName () const
 Retrieves the plug-in name. More...
 
ePLUGIN_TYPE GetType () const
 Retrieves the plug-in type. More...
 

Friends

class PluginBase
 
class Engine
 

Additional Inherited Members

- Public Types inherited from Castor3D::PluginBase
typedef OnLoadFunction * POnLoadFunction
 
typedef OnUnloadFunction * POnUnloadFunction
 
typedef GetTypeFunction * PGetTypeFunction
 
typedef GetRequiredVersionFunction * PGetRequiredVersionFunction
 
typedef GetNameFunction * PGetNameFunction
 
- Protected Member Functions inherited from Castor3D::PluginBase
C3D_API PluginBase (ePLUGIN_TYPE p_type, Castor::DynamicLibrarySPtr p_library, Engine &p_engine)
 Constructor. More...
 
- Protected Attributes inherited from Castor3D::PluginBase
PGetRequiredVersionFunction m_pfnGetRequiredVersion
 The plug-in's version checking function. More...
 
PGetNameFunction m_pfnGetName
 The plug-in's name retrieval function. More...
 
POnLoadFunction m_pfnOnLoad
 The plug-in's loading function. More...
 
POnUnloadFunction m_pfnOnUnload
 The plug-in's unloading function. More...
 
ePLUGIN_TYPE m_type
 The plug-in type. More...
 

Detailed Description

Divider Plugin class.

Author
Sylvain DOREMUS
Version
0.1
Date
09/02/2010

Constructor & Destructor Documentation

◆ DividerPlugin()

C3D_API Castor3D::DividerPlugin::DividerPlugin ( Castor::DynamicLibrarySPtr  p_library,
Engine p_engine 
)

Constructor.

Parameters
[in]p_libraryThe shared library holding the plug-in
[in]p_engineThe engine

◆ ~DividerPlugin()

virtual C3D_API Castor3D::DividerPlugin::~DividerPlugin ( )
virtual

Destructor.

Member Function Documentation

◆ CreateDivider()

C3D_API Subdivider* Castor3D::DividerPlugin::CreateDivider ( )

Creates the Subdivider.

Returns
The created Subdivider instance

◆ DestroyDivider()

C3D_API void Castor3D::DividerPlugin::DestroyDivider ( Subdivider p_pDivider)

Destroys the given Subdivider.

Parameters
[in]p_pDividerThe Subdivider

◆ GetDividerType()

C3D_API Castor::String Castor3D::DividerPlugin::GetDividerType ( )

Tells the divider short name.

Friends And Related Function Documentation

◆ Engine

friend class Engine
friend

◆ PluginBase

friend class PluginBase
friend

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