Chicane Graphics Engine - Documentation

Types

Name	Value	Description
Compiler	std::function<Component *(const pugi::xml_node &inNode)>

Constructors

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

Destructors

Name	Description
~Component()

Virtual Functions

Access	Return	Modifier	Name
public	bool	const	isDrawable()
protected	void	inline	onEvent( const WindowEvent& inEvent )
protected	void	inline	onTick( float inDeltaTime )
protected	void	inline	onRefresh()
protected	void	inline	onAdoption( Component* inChild )
protected	void	inline	onAdopted( Component* inParent )
protected	void	inline	onHover()
protected	void	inline	onClick()
protected	void	inline	refreshPrimitive()

Functions

Access	Return	Modifier	Name
public	bool	const	isRoot()
public	bool	const	isDisplayable()
public	bool	const	isVisible()
public	bool	const	isSolid()
public	bool	const	canAdopt( Component* inComponent )
public	void		hover()
public	void		click()
public	void		tick( float inDelta )
public	void		refresh()
public	const String&	const	getTag()
public	String	const	getId()
public	void		setId( const String& inValue )
public	std::vector<String>	const	getClassList()
public	const String&	const	getClassName()
public	void		setClassName( const String& inValue )
public	void	inline	addClassName( Args... inClasses )
public	String	const	getAttribute( const String& inName )
public	bool	const	hasStyleFile()
public	const StyleFile*	const	getStyleFile()
public	void		setStyleFile( StyleFile* inSource )
public	void		addStyleRuleset( const StyleRuleset::List& inSources )
public	void		addStyleProperties( const StyleRuleset::Properties& inSource )
public	const Style&	const	getStyle()
public	bool	const	hasReference( const String& inId, bool isLocalOnly )
public	Reference*	const	getReference( const String& inId )
public	void		addReference( const Reference::Map& inReference )
public	void		addReference( const String& inId, Reference* inReference )
public	void		removeReference( const String& inId )
public	bool	const	hasFunction( const String& inId, bool isLocalOnly )
public	const Function	const	getFunction( const String& inId, bool isLocalOnly )
public	void		addFunction( const Functions& inFunctions )
public	void		addFunction( const String& inId, Function inFunction )
public	void		removeFunction( const 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	hasNeighbours()
public	Component*	const	getNeighbour( int inJumps )
public	bool	const	hasChildren()
public	const std::vector<Component*>&	const	getChildren()
public	std::vector<Component*>	const	getChildrenFlat()
public	void		addChildren( const pugi::xml_node& inNode )
public	void		addChild( Component* inComponent )
public	Vec2	const	getChildrenContentSizeBlock()
public	Vec2	const	getChildrenContentSizeFlex()
public	Vec2	const	getChildrenContentSize()
public	const Vec2&	const	getSize()
public	void		setSize( const Vec2& inValue )
public	void		setSize( float inWidth, float inHeight )
public	const Vec2&	const	getScale()
public	void		setScale( const Vec2& inValue )
public	void		setScale( float inX, float inY )
public	const Vec2&	const	getPosition()
public	void		addPosition( const Vec2& inValue )
public	void		addPosition( float inX, float inY )
public	void		setPosition( const Vec2& inValue )
public	void		setPosition( float inX, float inY )
public	const Vec2&	const	getCursor()
public	void		addCursor( const Vec2& inValue )
public	void		addCursor( float inX, float inY )
public	void		setCursor( const Vec2& inValue )
public	void		setCursor( float inX, float inY )
public	const Bounds2D&	const	getBounds()
public	bool	const	hasPrimitive()
public	const Primitive&	const	getPrimitive()
public	void		clearPrimitive()
public	void		setPrimitive( const Primitive& inPrimitive )
public	String	const	parseText( const String& inValue )
protected	void		refreshStyle()
protected	void		refreshStyleRuleset()
protected	void		refreshSize()
protected	void		refreshPosition()
protected	void		refreshBounds()
protected	bool	const	isReference( const String& inValue )
protected	Reference	const	parseReference( const String& inValue )
protected	bool	const	isFunction( const String& inValue )
protected	FunctionData	const	parseFunction( const String& inRefValue )

Members

Access	Type	Modifier	Name
public	const char*	static, constexpr	EVENT_KEYWORD
public	const char*	static, constexpr	ON_HOVER_ATTRIBUTE_NAME
public	const char*	static, constexpr	ON_CLICK_ATTRIBUTE_NAME
protected	String		m_tag
protected	String		m_id
protected	String		m_className
protected	Style		m_style
protected	StyleFile*		m_styleFile
protected	Reference::Map		m_references
protected	Functions		m_functions
protected	Component*		m_root
protected	Component*		m_parent
protected	std::vector<Component*>		m_children
protected	Vec2		m_size
protected	Vec2		m_scale
protected	Vec2		m_position
protected	Vec2		m_cursor
protected	Bounds2D		m_bounds
protected	Primitive		m_primitive
protected	Xml::Attributes		m_attributes

Component

Types

Constructors

Destructors

Virtual Functions

Functions

Members