#include <CoreModifiable.h>

Inheritance diagram for CoreModifiable:

Classes
struct	ImportState
	Import. More...

Public Member Functions
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	InitModifiable ()
	default modifiable init : set all initparams to readonly and set initflag to true 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)

virtual bool	addItem (const CMSP &item, ItemPosition pos=Last)
	add item at first or last position

virtual bool	removeItem (const CMSP &item)
	remove item (son)

Static Public Member Functions
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...

Protected Member Functions
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

Static Protected Member Functions
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

Friends
class	CoreModifiableAttribute

class	KigsCore

Detailed Description

Base class for Kigs framework objects. CoreModifiable class manage a list of attributes supporting reflexion and serialization. CoreModifiable also support reference counting, auto update, instance factory...

Member Function Documentation

◆ Append()

void CoreModifiable::Append	(	std::string &	XMLString,
		const std::list< CoreModifiable * > &	toexport,
		bool	recursive,
		ExportSettings *	settings = `nullptr`
	)

static

static method to export the several CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree

call recursive, non static method

◆ debugPrintfFullTree()

void CoreModifiable::debugPrintfFullTree ( int maxindent = 3 )

static

Editor.

Debug

◆ Export() [1/3]

void CoreModifiable::Export	(	const std::string &	filename,
		CoreModifiable *	toexport,
		bool	recursive = `false`,
		ExportSettings *	settings = `nullptr`
	)

static

static method to export the given CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree

call recursive, non static method

◆ Export() [2/3]

void CoreModifiable::Export	(	std::string &	XMLString,
		const std::list< CoreModifiable * > &	toexport,
		bool	recursive,
		ExportSettings *	settings = `nullptr`
	)

static

static method to export the several CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree

call recursive, non static method

◆ Export() [3/3]

void CoreModifiable::Export	(	std::vector< CoreModifiable * > &	savedList,
		XMLNode *	currentNode,
		bool	recursive,
		ExportSettings *	settings
	)

protected

Export.

recursive method to export "this" to an XML file.

◆ ExportToXMLNode()

XMLNode * CoreModifiable::ExportToXMLNode	(	CoreModifiable *	toexport,
		XML *	owner_xml_file,
		bool	recursive,
		ExportSettings *	settings = `nullptr`
	)

static

static method to export the given CoreModifiable to an XML Node. if recursive flag is set to true, export also all sons tree

call recursive, non static method

◆ ExportToXMLString()

std::string CoreModifiable::ExportToXMLString	(	CoreModifiable *	toexport,
		bool	recursive,
		ExportSettings *	settings = `nullptr`
	)

static

static method to export the given CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree

call recursive, non static method

◆ InitModifiable()

void CoreModifiable::InitModifiable ( )

virtual

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

already done ? then return

Reimplemented in Mesh, AObject, Camera, FrameBufferStream, ModernMeshItemGroup, API3DUniformDataTexture, Octree, API3DUniformTexture, API3DUniformTexture, UIDynamicText, Base2DLayer, Texture, Node2D, API3DUniformFloat3, API3DUniformFloat3, RenderingScreen, Node3D, Scene3D, TextureHandler, Drawable, ModernMesh, CollisionManager, Panel, KigsBitmap, DrawVertice, Light, Window, API3DShader, AObjectSkeletonResource, Thread, CameraWUP, Plane, SkyBox, Timer, Node3DDelayed, ImGuiLayer, WorkerThread, StepByStepImporter, HTTPAsyncRequestWindows, DX11RenderingScreen, BaseUI2DLayer, UITextArea, TouchableCoordinateSystem, UIVideo, Abstract2DLayer, LuaBehaviour, API3DLight, UIText, PointInteretVignette, API3DUniformBase, API3DLight, API3DUniformBase, UIPointInteret, UISliderFill, UISlider, UISlidersGroup, OpenGLRenderingScreen, UIScrollView, CameraAndroid, GenericCamera, UITextInput, PassiveColoredMask, BSphere, Holo3DPanel, AudioBuffer, UIButtonText, UISprite, LuaImporter, UIMap, UIButton, API3DGenericMeshShader, UINode3DLayer, UIGroupButton, UIImage, API3DGenericMeshShader, OpenGLTexture, DX11Texture, UIButtonImage, CoreSequenceLauncher, UI3DLinkedItem, CollisionBaseNode, UserPositionGPS, MPEG4Encoder, AlphaMask, Box2DBody, FixedImageBufferStream, BCylinder, GPSTrigger, ThreadPoolManager, UIRenderingScreen, ResourceDownloader, UIImageHighlight, Box2DShape, OpenGLMaterial, UIRoundHUD, HTTPConnect, HTTPAsyncRequestWUP, UICustomInputItem, BoxCollider, UIStream, HTTPAsyncRequestAndroid, HTTPConnectAndroid, ColladaParser, CameraWindows, OpenGLRenderingScreen, SoundManagerAndroid, ShrinkerWUP, ShrinkerWindows, HTTPConnectWindows, HTTPAsyncRequestIOS, HTTPAsyncRequestJS, HTTPConnectJS, and HTTPConnectWUP.

◆ InitParametersFromList()

void CoreModifiable::InitParametersFromList ( const std::vector< CoreModifiableAttribute * > * params )

Utility.

utility method : init CoreModifiable parameters from given parameter list

◆ ProtectedDestroy()

void CoreModifiable::ProtectedDestroy ( )

virtual

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

remove all items

Reimplemented in Camera, DrawVertice, API3DShader, API3DUniformBase, UIPointInteret, DX11Texture, OpenGLTexture, and GPSTrigger.

◆ UninitModifiable()

void CoreModifiable::UninitModifiable ( )

virtual

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

not init ? return

Reimplemented in Camera, Texture, Scene3D, DX11RenderingScreen, LuaBehaviour, OpenGLRenderingScreen, OpenGLTexture, and DX11Texture.

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

G:/Projects/Github/kigs/framework/Core/Headers/CoreModifiable.h
G:/Projects/Github/kigs/framework/Core/Headers/AttributePacking.h
G:/Projects/Github/kigs/framework/Core/Headers/CoreModifiableTemplateImport.h
G:/Projects/Github/kigs/framework/Core/Sources/CoreModifiable.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Function Documentation

◆ Append()

◆ debugPrintfFullTree()

◆ Export() [1/3]

◆ Export() [2/3]

◆ Export() [3/3]

◆ ExportToXMLNode()

◆ ExportToXMLString()

◆ InitModifiable()

◆ InitParametersFromList()

◆ ProtectedDestroy()

◆ UninitModifiable()