Kigs Framework  Doc version 0.8
Open source multi purpose Rapid Application Development framework
Public Member Functions | Protected Member Functions | List of all members
API3DUniformBase Class Referenceabstract

#include <HLSLUniform.h>

Inheritance diagram for API3DUniformBase:
Drawable SceneNode CoreModifiable GenericRefCountedBaseClass API3DUniformBuffer API3DUniformDataTexture API3DUniformFloat API3DUniformFloat2 API3DUniformFloat3 API3DUniformFloat4 API3DUniformGeneratedTexture API3DUniformInt API3DUniformMatrixArray API3DUniformTexture

Public Member Functions

void ProtectedDestroy () override
 Destroy method decrement refcounter and delete instance if no more used. More...
 
- Public Member Functions inherited from Drawable
virtual void DoPreDraw (TravState *)
 pre draw method More...
 
virtual void DoDraw (TravState *travstate)
 draw method More...
 
virtual void DoPostDraw (TravState *travstate)
 post draw method More...
 
void CheckPostDraw (TravState *travstate)
 check before calling corresponding DoPredraw More...
 
virtual bool BBoxUpdate (kdouble time)
 update the bounding box More...
 
bool addItem (const CMSP &item, ItemPosition pos=Last) override
 add item in scene tree More...
 
bool removeItem (const CMSP &item) override
 remove item in scene tree More...
 
virtual void GetGlobalPosition (Matrix3x4 *pLocalToGlobal, kfloat &x, kfloat &y, kfloat &z)
 get the global position of the drawable More...
 
- Public Member Functions inherited from SceneNode
bool addItem (const CMSP &item, ItemPosition pos=Last DECLARE_DEFAULT_LINK_NAME) override
 add item at first or last position
 
- Public Member Functions inherited from CoreModifiable
void Init ()
 Modifiable managmenent.
 
void EmptyItemList ()
 remove all items (sons)
 
CMSP GetInstanceByPath (const std::string &path)
 return the instance corresponding to the given path in sons tree
 
std::string GetRuntimeID () const
 ID.
 
CoreModifiableAttributegetAttribute (KigsID labelid) const
 Attribute management.
 
u32 getNbArrayElements (KigsID attributeLabel) const
 return element count for an array type attribute
 
template<typename attribute_type , typename value_type >
attribute_type * AddDynamicAttribute (KigsID ID, const value_type &value)
 Dynamic attribute management.
 
const kigs::unordered_map< KigsID, ModifiableMethodStruct > * GetMethods ()
 Method management.
 
bool aggregateWith (CMSP &item, ItemPosition pos=Last)
 Aggregate management.
 
void flagAsNotificationCenterRegistered ()
 Flags.
 
void InitParametersFromList (const std::vector< CoreModifiableAttribute * > *params)
 Utility. More...
 
virtual void UninitModifiable ()
 called when InitModifiable has failled : reset read/write flag on all init params More...
 
virtual void addUser (CoreModifiable *user)
 add the given parent to list
 
virtual void removeUser (CoreModifiable *user)
 remove user (parent)
 

Protected Member Functions

void InitModifiable () override
 init the modifiable and set the _isInit flag to true if OK
 
bool PreDraw (TravState *) override
 initialise pre draw method More...
 
bool PostDraw (TravState *) override
 initialise PostDraw method More...
 
void InitModifiable () override
 init the modifiable and set the _isInit flag to true if OK
 
bool PreDraw (TravState *) override
 initialise pre draw method More...
 
bool PostDraw (TravState *) override
 initialise PostDraw method More...
 
- Protected Member Functions inherited from Drawable
virtual bool Draw (TravState *)
 initialise draw method More...
 
virtual void FatherNode3DNeedBoundingBoxUpdate ()
 update the father node bounding box
 
- Protected Member Functions inherited from CoreModifiable
void UpdateAggregates (const Timer &timer, void *addParam)
 Internals.
 
void Export (std::vector< CoreModifiable * > &savedList, XMLNode *currentNode, bool recursive, ExportSettings *settings)
 Export. More...
 
CoreModifiableAttributeGenericCreateDynamicAttribute (CoreModifiable::ATTRIBUTE_TYPE type, KigsID ID)
 create and add dynamic attribute except arrays
 

Additional Inherited Members

- Static Public Member Functions inherited from CoreModifiable
static std::vector< CMSP > GetRootInstances (const KigsID &cid, bool exactTypeOnly=false)
 static method : return the set of all root instances of the given type
 
static void Append (std::string &XMLString, const std::list< CoreModifiable * > &toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the several CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static void Export (const std::string &filename, CoreModifiable *toexport, bool recursive=false, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static XMLNodeExportToXMLNode (CoreModifiable *toexport, XML *owner_xml_file, bool recursive, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML Node. if recursive flag is set to true, export also all sons tree More...
 
static std::string ExportToXMLString (CoreModifiable *toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static void Export (std::string &XMLString, const std::list< CoreModifiable * > &toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the several CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static CMSP Import (const std::string &filename, bool noInit=false, bool keepImportFileName=false, ImportState *state=nullptr, const std::string &override_name="")
 return an new CoreModifiable instance using the description found in XML file given by name
 
static CMSP GetInstanceByGlobalPath (const std::string &path)
 static method : return the instance corresponding to the given path, and given search start
 
static void debugPrintfFullTree (int maxindent=3)
 Editor. More...
 
- Static Protected Member Functions inherited from CoreModifiable
template<typename StringType >
static CMSP Import (XMLNodeTemplate< StringType > *currentNode, CoreModifiable *currentModifiable, ImportState &importState)
 recusrive method to add sons and attributes found in the XML file
 

Detailed Description

Base class for uniform, DX11 API.

Base class for GLSL uniforms.

Member Function Documentation

◆ PostDraw() [1/2]

bool API3DUniformBase::PostDraw ( TravState state)
overrideprotectedvirtual

initialise PostDraw method

Parameters
travstate: camera state
Returns
TRUE if a could PostDraw

Reimplemented from Drawable.

◆ PostDraw() [2/2]

bool API3DUniformBase::PostDraw ( TravState state)
overrideprotectedvirtual

initialise PostDraw method

Parameters
travstate: camera state
Returns
TRUE if a could PostDraw

Reimplemented from Drawable.

◆ PreDraw() [1/2]

bool API3DUniformBase::PreDraw ( TravState state)
overrideprotectedvirtual

initialise pre draw method

Parameters
TravState: camera state
Returns
TRUE if a could PreDraw

Reimplemented from Drawable.

◆ PreDraw() [2/2]

bool API3DUniformBase::PreDraw ( TravState state)
overrideprotectedvirtual

initialise pre draw method

Parameters
TravState: camera state
Returns
TRUE if a could PreDraw

Reimplemented from Drawable.

◆ ProtectedDestroy()

void API3DUniformBase::ProtectedDestroy ( )
overridevirtual

Destroy method decrement refcounter and delete instance if no more used.

remove all items

Reimplemented from CoreModifiable.


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