#include <BaseUI2DLayer.h>

Inheritance diagram for BaseUI2DLayer:

Public Member Functions
void	TravDraw (TravState *state) override
	Do drawing here if any.

Public Member Functions inherited from Abstract2DLayer
	Abstract2DLayer (const kstl::string &name, DECLARE_CLASS_NAME_TREE_ARG)
	constructor More...

Public Member Functions inherited from Scene3D
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.

CoreModifiableAttribute *	getAttribute (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
	default modifiable init : set all initparams to readonly and set initflag to true More...

Protected Member Functions inherited from Abstract2DLayer
bool	StartDrawing (TravState *state)
	set rendering screen active

void	EndDrawing (TravState *state)
	close rendering screen

Protected Member Functions inherited from Scene3D
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...

CoreModifiableAttribute *	GenericCreateDynamicAttribute (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 XMLNode *	ExportToXMLNode (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

Protected Attributes inherited from Abstract2DLayer
maReference	mRenderingScreen
	pointer to the renderingSreen

maInt	mSizeX
	size on X axis

maInt	mSizeY
	size on Y axis

Protected Attributes inherited from Scene3D
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.

Detailed Description

UI rendering support.

pointer to the renderingSreen

2 BaseUI2DLayer inherits Abstract2DLayer. It have to be added to SceneGraph and is sorted by Priority with other 2DLayers and Scene3D.

Attributes

Key : RenderingScreen (Init attribute)

Type : reference

pointer to the renderingSreen

Key : SequenceManager (Init attribute)

Type : reference
Default Value : DataDrivenSequenceManager:AppSequenceManager

Key : ClearColor

Type : array [ 4 ]
Default Value : {0.000000,0.000000,0.000000,1.000000}

Key : ClearColorBuffer

Type : bool
Default Value : false

Key : ClearZBuffer

Type : bool
Default Value : false

Key : IsInteractive

Type : bool
Default Value : true

Key : SizeX

Type : int
Default Value : -1

size on X axis

Key : SizeY

Type : int
Default Value : -1

size on Y axis

Inherited Attributes

Inherited Methods

Member Function Documentation

◆ InitModifiable()

void BaseUI2DLayer::InitModifiable ( )

overrideprotectedvirtual

default modifiable init : set all initparams to readonly and set initflag to true

already done ? then return

Reimplemented from Abstract2DLayer.

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

G:/Projects/Github/kigs/framework/2DLayers/Headers/BaseUI2DLayer.h
G:/Projects/Github/kigs/framework/2DLayers/Sources/BaseUI2DLayer.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members