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

#include <Drawable.h>

Inheritance diagram for Drawable:
SceneNode CoreModifiable GenericRefCountedBaseClass API3DUniformBase AudioBuffer AudioListenerActivator Billboard3D CollisionBaseNode DebugDraw DrawableCallback DrawableSwitch DrawVertice Fog HDrawable Holo3DPanel KigsBitmap Material MaterialStage MeshItemGroup ModernMeshItemGroup RendererMatrix RenderingCustomizer ShaderBase SimpleDrawing SkyBox Sprite StencilMask TangentSpaceLOD Texture TextureMatrix

Public Member Functions

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 ProtectedDestroy ()
 Destroy method decrement refcounter and delete instance if no more used. 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
 
virtual bool PreDraw (TravState *)
 initialise pre draw method More...
 
virtual bool Draw (TravState *)
 initialise draw method More...
 
virtual bool PostDraw (TravState *)
 initialise PostDraw 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 all drawable objects.

Drawable objects can generally be shared ( textures, meshes ... ) to be drawn several times.

Member Function Documentation

◆ addItem()

bool Drawable::addItem ( const CMSP &  item,
ItemPosition pos  DECLARE_LINK_NAME = Last 
)
overridevirtual

add item in scene tree

Parameters
item: item to add
linkName: name of the added item
Returns
TRUE if the item is added, FALSE otherwise

Reimplemented from CoreModifiable.

Reimplemented in Holo3DPanel, API3DUniformTexture, API3DUniformTexture, and DrawableSwitch.

◆ BBoxUpdate()

bool Drawable::BBoxUpdate ( kdouble  time)
inlinevirtual

update the bounding box

Parameters
time: world time
Returns
FALSE if object without bounding box, TRUE otherwise

Reimplemented in ModernMeshItemGroup, MeshItemGroup, SkyBox, SimpleDrawing, DrawVertice, ModernMesh, AudioBuffer, DebugDraw, DrawableSwitch, AudioListenerActivator, and CollisionBaseNode.

◆ CheckPostDraw()

void Drawable::CheckPostDraw ( TravState travstate)
inline

check before calling corresponding DoPredraw

check before calling corresponding DoPostPredraw

check before calling corresponding DoDraw

Parameters
travstate: camera state

◆ DoDraw()

void Drawable::DoDraw ( TravState travstate)
virtual

draw method

Parameters
TravState: camera state

Reimplemented in HDrawable, DrawableSwitch, and DrawableCallback.

◆ DoPostDraw()

void Drawable::DoPostDraw ( TravState travstate)
virtual

post draw method

Parameters
travstate: camera state

Reimplemented in Material, API3DShader, HDrawable, API3DShader, DrawableSwitch, and DrawableCallback.

◆ DoPreDraw()

void Drawable::DoPreDraw ( TravState state)
virtual

pre draw method

Parameters
TravState: camera state

Reimplemented in Material, Mesh, API3DShader, API3DShader, HDrawable, DrawableSwitch, and DrawableCallback.

◆ Draw()

bool Drawable::Draw ( TravState state)
protectedvirtual

initialise draw method

Parameters
TravState: camera state
Returns
TRUE if a could draw

Reimplemented in SimpleDrawing, ModernMeshItemGroup, DrawVertice, Holo3DPanel, OpenGLHolo3DPanel, DebugDraw, and Billboard3D.

◆ GetGlobalPosition()

void Drawable::GetGlobalPosition ( Matrix3x4 *  pLocalToGlobal,
kfloat &  x,
kfloat &  y,
kfloat &  z 
)
inlinevirtual

get the global position of the drawable

Parameters
pLocalToGlobal: conversion matrix
x: coordinate on x axis (in/out param)
y: coordinate on y axis (in/out param)
z: coordinate on z axis (in/out param)

◆ PostDraw()

bool Drawable::PostDraw ( TravState state)
protectedvirtual

initialise PostDraw method

Parameters
travstate: camera state
Returns
TRUE if a could PostDraw

Reimplemented in ModernMeshItemGroup, MaterialStage, DX11Texture, DX11Material, AudioListenerActivator, OpenGLMaterial, OpenGLTexture, RendererMatrix, API3DUniformBase, API3DUniformBase, and API3DShader.

◆ PreDraw()

bool Drawable::PreDraw ( TravState state)
protectedvirtual

◆ removeItem()

bool Drawable::removeItem ( const CMSP &  item)
overridevirtual

remove item in scene tree

Parameters
item: item to remove
linkName: name of the removed item
Returns
TRUE if the item is removed, FALSE otherwise

Reimplemented from CoreModifiable.

Reimplemented in Holo3DPanel.


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