Serializable

Header

Includes/Chicane/Core/Serializable.hpp

Namespace

Chicane::Serializable

Types

Name	Value	Description
AttributeMap	XmlNode::Attributes
AttributeCallback	std::function<void(const String &)>
AttributeObservable	EventObservable<String>
AttributeSubscription	EventSubscription<String>
Watchers	std::unordered_map<String, AttributeObservable>

Constructors

Name	Description
Serializable()
Serializable()
Serializable()

Destructors

Name	Description
~Serializable()

Virtual Functions

Access	Return	Modifier	Name	Description
public	void		onAttributeSync()
protected	void		onAttributeChange( const String& inName, const String& inValue )

Functions

Access	Return	Modifier	Name
public	Serializable&		operator=()
public	Serializable&		operator=()
public	void		load( const FileSystem::Path& inFilepath )
public	void		save()
public	void		save( const FileSystem::Path& inFilepath )
public	void		parse( const XmlNode& inNode )
public	XmlNode		createRoot( const String& inName )
public	const FileSystem::Path&	const	getFilepath()
public	void		setFilepath( const FileSystem::Path& inFilepath )
public	const XmlDocument&	const	getDocument()
public	XmlDocument&		getDocument()
public	const XmlNode&	const	getSource()
public	XmlNode&		getSource()
public	const AttributeMap&	const	getAttributes()
public	bool	const	hasAttribute( const String& inName )
public	const String&	const	getAttribute( const String& inName )
public	void		setAttribute( const String& inName, const String& inValue )
public	void		removeAttribute( const String& inName )
public	float	const	getFloat( const String& inName, float inFallback )
public	bool	const	getBool( const String& inName, bool inFallback )
public	std::uint32_t	const	getUint( const String& inName, std::uint32_t inFallback )
public	String	const	getString( const String& inName, const String& inFallback )
public	Vec3	const	getVec3( const String& inName, const Vec3& inFallback )
public	Vec4	const	getColor( const String& inName, const Vec4& inFallback )
public	AttributeSubscription		watchAttribute( const String& inName, const AttributeCallback& inCallback )
protected	void		bindSource( const XmlNode& inNode )
protected	void		syncAttributes()
protected	void		emitAttribute( const String& inName, const String& inValue )
protected	void		writeAttributesToSource()

Members

Access	Type	Name
protected	FileSystem::Path	m_filepath
protected	XmlDocument	m_document
protected	XmlNode	m_source
protected	AttributeMap	m_attributes
protected	Watchers	m_watchers