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

#include <Scene3D.h>

Inheritance diagram for Scene3D:
Node3D SceneNode CoreModifiable GenericRefCountedBaseClass Abstract2DLayer Base2DLayer BaseUI2DLayer ImGuiLayer

Public Member Functions

void TravCull (TravState *state) override
 call cull process for this node and all sons at visible positions More...
 
bool operator< (Scene3D const &A) const
 overload operator < for comparison
 
void NotifyUpdate (const unsigned int) override
 to be done when changing More...
 
virtual bool removeLight (CoreModifiable *light)
 remove a light return true if light was attached to this scene More...
 
virtual void addLight (CoreModifiable *light)
 add a light More...
 
virtual void addCamera (CoreModifiable *camera)
 add a camera More...
 
virtual bool removeCamera (CoreModifiable *camera)
 remove a camera return true if camera was attached to this scene More...
 
virtual bool hasLight (CoreModifiable *light)
 true is has a light More...
 
- Public Member Functions inherited from Node3D
 DECLARE_DECORABLE_2_PARAMS (bool, Cull, Node3D, TravState *, unsigned int)
 
bool addItem (const CMSP &item, ItemPosition pos=Last DECLARE_DEFAULT_LINK_NAME) override
 add item at first or last position
 
bool removeItem (const CMSP &item DECLARE_DEFAULT_LINK_NAME) override
 
void localMove (const v3f &move)
 move local node position ( pos = move + pos )
 
void globalMove (const v3f &move)
 move global node position ( gpos = gmove + gpos )
 
- 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 ProtectedDestroy ()
 Destroy method decrement refcounter and delete instance if no more used. More...
 
virtual bool removeItem (const CMSP &item)
 remove item (son)
 

Protected Member Functions

void InitModifiable () override
 initialize modifiable
 
void UninitModifiable () override
 called when InitModifiable has failled : reset read/write flag on all init params More...
 
- Protected Member Functions inherited from Node3D
void removeUser (CoreModifiable *user) override
 remove user (parent)
 
void addUser (CoreModifiable *user) override
 add the given parent to list
 
void PreDrawDrawable (TravState *state)
 call predraw for drawable sons of this node return true if at least one drawable son was found More...
 
void DrawDrawable (TravState *state)
 call draw for drawable sons of this node More...
 
void PostDrawDrawable (TravState *state)
 call postdraw for drawable sons of this node More...
 
void RecomputeGlobalToLocal ()
 
void RecomputeGlobalBoundingBox ()
 
virtual void RecomputeBoundingBox ()
 
- 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
 

Protected Attributes

kstl::set< Camera *, sortCamera > mCameras
 link to the cameras
 
kstl::set< CoreModifiable * > mLights
 link to the lights
 
maInt mPriority
 priority
 
- Protected Attributes inherited from Node3D
unsigned int mIsVisible
 valid after scene TravCull : mIsVisible store current frame index if object is visible
 
unsigned short mFirstVisibleNodeIndex
 first visible Node in ModuleSceneGraph::mVisiblesNodeList
 
unsigned short mVisibleNodeCount
 number of visible node
 
Matrix3x4 mTransform
 Local transformation matrix (father => this local coordinate system)
 
Matrix3x4 mLocalToGlobal
 Local to global transformation matrix (Local coordinate system => global "world" coordinate system)
 
Matrix3x4 mGlobalToLocal
 Global to local transformation matrix (Global "world" coordinate system => local coordinate system)
 
BBox mLocalBBox
 AABounding box in local coordinate system.
 
BBox mBBox
 AABounding box in father coordinate system.
 
BBox mGlobalBBox
 AABounding box in global "world" coordinate system.
 

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

Root Node3D for a scene.

priority

Attributes

Key : Priority

Key : Sort3DNodesFrontToBack

Inherited Attributes

Methods

Key : GetCameraVector

Key : SortItemsFrontToBack

Inherited Methods

Member Function Documentation

◆ addCamera()

bool Scene3D::addCamera ( CoreModifiable camera)
virtual

add a camera

true if has a camera

Parameters
camera: camera to add
camera: camera checked

Reimplemented in Base2DLayer.

◆ addLight()

void Scene3D::addLight ( CoreModifiable light)
virtual

add a light

Parameters
light: light to add

◆ hasLight()

bool Scene3D::hasLight ( CoreModifiable light)
virtual

true is has a light

Parameters
light: light to add

◆ NotifyUpdate()

void Scene3D::NotifyUpdate ( const unsigned int  )
override

to be done when changing

Parameters
int: not used

◆ removeCamera()

bool Scene3D::removeCamera ( CoreModifiable camera)
virtual

remove a camera return true if camera was attached to this scene

Parameters
camera: remove a camera

Reimplemented in Base2DLayer.

◆ removeLight()

bool Scene3D::removeLight ( CoreModifiable light)
virtual

remove a light return true if light was attached to this scene

Parameters
light: remove a light

◆ TravCull()

void Scene3D::TravCull ( TravState state)
overridevirtual

call cull process for this node and all sons at visible positions

Parameters
state: travstate

Reimplemented from Node3D.

◆ UninitModifiable()

void Scene3D::UninitModifiable ( )
overrideprotectedvirtual

called when InitModifiable has failled : reset read/write flag on all init params

not init ? return

Reimplemented from CoreModifiable.


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