Chicane Engine - Documentation

Types

Name	Value	Description
Compiler	std::function<Component *(const pugi::xml_node &inNode)>
ChildrenObservable	Observable<Component*>
ChildrenSubscription	Subscription<Component*>
Super	Component

Constructors

Name	Description
Component( const pugi::xml_node& inNode )
Component( const std::string& inTag )

Destructors

Name	Description
~Component()

Virtual Functions

Access	Return	Modifier	Name
public	bool	const	isDrawable()
protected	void	inline	onEvent( const Window::Event& inEvent )
protected	void	inline	onTick( float inDelta )
protected	void	inline	onRefresh()
protected	void	inline	onAdoption( Component* inChild )
protected	void	inline	onAdopted( Component* inParent )
protected	void	inline	refreshPrimitive()

Functions

Access	Return	Modifier	Name
public	bool	const	isRoot()
public	bool	const	isVisible()
public	bool	const	isValidChild( Component* inComponent )
public	void		tick( float inDelta )
public	void		refresh()
public	const std::string&	const	getTag()
public	void		setTag( const std::string& inTag )
public	const std::string&	const	getId()
public	void		setId( const std::string& inId )
public	const std::vector<std::string>	const	getClasses()
public	const std::string&	const	getClass()
public	void		setClass( const std::string& inClass )
public	const Style::Instance&	const	getStyle()
public	void		setStyle( const Style::Source::List& inSources )
public	void		setStyle( const Style::Properties& inSource )
public	bool	const	hasReference( const std::string& inId, bool isLocalOnly )
public	Reference*	const	getReference( const std::string& inId )
public	void		addReference( const Reference::Map& inReference )
public	void		addReference( const std::string& inId, Reference* inReference )
public	void		removeReference( const std::string& inId )
public	bool	const	hasFunction( const std::string& inId, bool isLocalOnly )
public	const Function	const	getFunction( const std::string& inId )
public	void		addFunction( const Functions& inFunctions )
public	void		addFunction( const std::string& inId, Function inFunction )
public	void		removeFunction( const std::string& inId )
public	bool	const	hasRoot()
public	Component*	const	getRoot()
public	void		setRoot( Component* inComponent )
public	bool	const	hasParent()
public	Component*	const	getParent()
public	void		setParent( Component* inComponent )
public	bool	const	hasChildren()
public	const std::vector<Component*>&	const	getChildren()
public	void		addChildren( const pugi::xml_node& inNode )
public	void		addChild( Component* inComponent )
public	ChildrenSubscription		watchChildren( ChildrenSubscription::NextCallback inNext, ChildrenSubscription::ErrorCallback inError, ChildrenSubscription::CompleteCallback inComplete )
public	const Vec2&	const	getCursor()
public	void		addCursor( const Vec2& inCursor )
public	void		addCursor( float inX, float inY )
public	void		setCursor( const Vec2& inCursor )
public	void		setCursor( float inX, float inY )
public	Vec2	const	getAvailableSize()
public	const Vec2&	const	getSize()
public	void		setSize( const Vec2& inSize )
public	void		setSize( float inWidth, float inHeight )
public	const Vec2&	const	getPosition()
public	void		setPosition( const Vec2& inPosition )
public	void		setPosition( float inX, float inY )
public	bool	const	hasPrimitive()
public	const Primitive&	const	getPrimitive()
public	void		clearPrimitive()
public	void		setPrimitive( const Primitive& inPrimitive )
public	std::string	const	parseText( const std::string& inValue )
protected	void		refreshStyle()
protected	void		refreshSize()
protected	void		refreshPosition()
protected	bool	const	isReference( const std::string& inValue )
protected	Reference	const	parseReference( const std::string& inValue )
protected	bool	const	isFunction( const std::string& inValue )
protected	FunctionData	const	parseFunction( const std::string& inRefValue )

Members

Access	Type	Name
protected	std::string	m_tag
protected	std::string	m_id
protected	std::string	m_class
protected	Style::Instance	m_style
protected	Reference::Map	m_references
protected	Functions	m_functions
protected	Component*	m_root
protected	Component*	m_parent
protected	std::vector<Component*>	m_children
protected	ChildrenObservable	m_childrenObservable
protected	Vec2	m_size
protected	Vec2	m_position
protected	Vec2	m_cursor
protected	Primitive	m_primitive

Component

Types

Constructors

Destructors

Virtual Functions

Functions

Members