Chicane Graphics Engine - Documentation

Types

Name	Value	Description
AnimatedValues	std::array<float, StylePropertyTable::VALUE_COUNT>
AnimatedMask	std::bitset<StylePropertyTable::COUNT>
Transitions	std::array<const StyleTransition*, StylePropertyTable::COUNT>

Constructors

Name	Description
Style( const StyleRuleset::Properties& inProperties, Component* inParent )
Style()

Functions

Access	Return	Modifier	Name
public	bool	const	isDisplay( StyleDisplay inValue )
public	bool	const	isPosition( StylePosition inValue )
public	bool	const	isPositioned()
public	bool	const	isClippingOverflow()
public	bool	const	isFillPercent( const String& inRaw )
public	void		resolveFillPercent( const Vec2& inRemaining )
public	void	const	clampSize( float& outWidth, float& outHeight )
public	float	const	insetLeft()
public	float	const	insetRight()
public	float	const	insetTop()
public	float	const	insetBottom()
public	float	const	insetHorizontal()
public	float	const	insetVertical()
public	void		setProperties( const StyleRuleset::Properties& inProperties )
public	void		copyValuesFrom( const Style& inStyle )
public	void		resetValues()
public	void		snapshot()
public	void		restore()
public	bool	const	readAnimated( StylePropertyId inId, float* outValues )
public	void		writeAnimated( StylePropertyId inId, const float* inValues )
public	const AnimatedValues&	const	getSnapshotValues()
public	const AnimatedMask&	const	getSnapshotMask()
public	const StyleTransition*	const	findTransition( StylePropertyId inId )
public	StyleTransform	const	getTransform()
public	Vec2	const	getTransformOrigin()
public	Vec2	const	getTransformOrigin( const Vec2& inBox )
public	bool	const	hasParent()
public	void		setParent( const Component* inComponent )
public	void		refresh()
private	bool	static	coversProperty( const String& inProperty, const String& inTarget )
private	void		refreshTransitionLookup()
private	bool	const	canKeepFillPercent( SizeDirection inDirection )
private	float	const	preservedFillPercent( float inParsed, float inLaidOut )
private	void		refreshDisplay()
private	void		refreshFlex()
private	void		refreshZIndex()
private	void		refreshSize()
private	void		refreshPosition()
private	void		refreshAlignment()
private	void		refreshMargin()
private	void		refreshPadding()
private	void		refreshBorder()
private	void		refreshGap()
private	void		refreshOverflow()
private	void		refreshRadius()
private	void		refreshBackground()
private	void		refreshForegroundColor()
private	void		refreshOpacity()
private	void		refreshFilter()
private	void		refreshTransform()
private	void		refreshFont()
private	void		refreshLetterSpacing()
private	void		refreshCursor()
private	void		parseTransitions( const StyleRuleset::Properties& inProperties )
private	void		parseAnimation( const StyleRuleset::Properties& inProperties )
private	StyleOverflow	const	parseOverflow( const String& inValue )
private	StyleBorderType	const	parseBorderType( const String& inValue )
private	WindowCursor	const	parseCursor( const String& inValue )
private	Color::Rgba	const	parseColor( const String& inValue )
private	StyleGradient	const	parseGradient( const String& inValue )
private	float	const	parseFilter( const String& inValue )
private	StyleTransform	const	parseTransform( const String& inValue )
private	Vec2	const	parseTranslation( const String& inValue )
private	float	const	parseRotation( const String& inValue )
private	Vec2	const	parseScale( const String& inValue )
private	Vec2	const	parseTransformOrigin( const String& inValue )
private	Vec2	const	parseTransformOrigin( const String& inValue, const Vec2& inBox )
private	float	const	parseSize( const String& inValue, SizeDirection inDirection, const Vec2* inBox )
private	float	const	parseSizeLimit( const String& inValue, SizeDirection inDirection )
private	float	const	parseWeight( const String& inValue )
private	String	const	parseReference( const String& inValue )
private	String	const	parseText( const String& inValue )
public	std::vector<String>		splitOneliner( const String& inValue )

Members

Access	Type	Modifier	Name
public	const char*	static, constexpr	FILE_EXTENSION_NAME
public	const char*	static, constexpr	ATTRIBUTE_NAME
public	const char*	static, constexpr	REFERENCE_KEYWORD
public	const char*	static, constexpr	IMPORT_KEYWORD
public	const char*	static, constexpr	URL_KEYWORD
public	const char	static, constexpr	COMMAND_ENDING
public	const char	static, constexpr	VARIABLE_KEYWORD
public	const char	static, constexpr	RULESET_OPENING
public	const char	static, constexpr	RULESET_CLOSING
public	const char	static, constexpr	ONELINE_SEPARATOR
public	const char	static, constexpr	SELECTOR_SEPARATOR
public	const char	static, constexpr	CLASS_SEPARATOR
public	const char	static, constexpr	ID_SELECTOR
public	const char	static, constexpr	CLASS_SELECTOR
public	const char	static, constexpr	INCLUSIVE_SELECTOR
public	const char	static, constexpr	SELECTOR_INHERITANCE
public	const char	static, constexpr	SELECTOR_SEPARATOR_COMMA
public	const char	static, constexpr	SELECTOR_SEPARATOR_SPACE
public	const char	static, constexpr	PSEUDO_CLASS_SELECTOR
public	const char*	static, constexpr	PSEUDO_CLASS_HOVER
public	const char*	static, constexpr	PSEUDO_CLASS_FOCUS
public	const char*	static, constexpr	PSEUDO_CLASS_DRAG
public	const char*	static, constexpr	DISPLAY_ATTRIBUTE_NAME
public	const char*	static, constexpr	DISPLAY_TYPE_FLEX
public	const char*	static, constexpr	DISPLAY_TYPE_BLOCK
public	const char*	static, constexpr	DISPLAY_TYPE_HIDDEN
public	const char*	static, constexpr	DISPLAY_TYPE_NONE
public	const char*	static, constexpr	OVERFLOW_ATTRIBUTE_NAME
public	const char*	static, constexpr	OVERFLOW_X_ATTRIBUTE_NAME
public	const char*	static, constexpr	OVERFLOW_Y_ATTRIBUTE_NAME
public	const char*	static, constexpr	OVERFLOW_TYPE_VISIBLE
public	const char*	static, constexpr	OVERFLOW_TYPE_HIDDEN
public	const char*	static, constexpr	OVERFLOW_TYPE_SCROLL
public	const char*	static, constexpr	OVERFLOW_TYPE_AUTO
public	const char*	static, constexpr	Z_INDEX_ATTRIBUTE_NAME
public	const char*	static, constexpr	CURSOR_ATTRIBUTE_NAME
public	const char*	static, constexpr	CURSOR_TYPE_AUTO
public	const char*	static, constexpr	CURSOR_TYPE_DEFAULT
public	const char*	static, constexpr	CURSOR_TYPE_POINTER
public	const char*	static, constexpr	CURSOR_TYPE_TEXT
public	const char*	static, constexpr	CURSOR_TYPE_CROSSHAIR
public	const char*	static, constexpr	CURSOR_TYPE_MOVE
public	const char*	static, constexpr	CURSOR_TYPE_NOT_ALLOWED
public	const char*	static, constexpr	CURSOR_TYPE_WAIT
public	const char*	static, constexpr	CURSOR_TYPE_PROGRESS
public	const char*	static, constexpr	CURSOR_TYPE_GRAB
public	const char*	static, constexpr	CURSOR_TYPE_GRABBING
public	const char*	static, constexpr	CURSOR_TYPE_NS_RESIZE
public	const char*	static, constexpr	CURSOR_TYPE_EW_RESIZE
public	const char*	static, constexpr	CURSOR_TYPE_NESW_RESIZE
public	const char*	static, constexpr	CURSOR_TYPE_NWSE_RESIZE
public	const char*	static, constexpr	CURSOR_TYPE_NONE
public	const char*	static, constexpr	FLEX_DIRECTION_ATTRIBUTE_NAME
public	const char*	static, constexpr	FLEX_DIRECTION_TYPE_ROW
public	const char*	static, constexpr	FLEX_DIRECTION_TYPE_COLUMN
public	const char*	static, constexpr	FLEX_WRAP_ATTRIBUTE_NAME
public	const char*	static, constexpr	FLEX_WRAP_TYPE_NOWRAP
public	const char*	static, constexpr	FLEX_WRAP_TYPE_WRAP
public	const char*	static, constexpr	WIDTH_ATTRIBUTE_NAME
public	const char*	static, constexpr	HEIGHT_ATTRIBUTE_NAME
public	const char*	static, constexpr	MIN_WIDTH_ATTRIBUTE_NAME
public	const char*	static, constexpr	MIN_HEIGHT_ATTRIBUTE_NAME
public	const char*	static, constexpr	MAX_WIDTH_ATTRIBUTE_NAME
public	const char*	static, constexpr	MAX_HEIGHT_ATTRIBUTE_NAME
public	const char*	static, constexpr	SIZE_LIMIT_TYPE_NONE
public	const char*	static, constexpr	POSITION_ATTRIBUTE_NAME
public	const char*	static, constexpr	POSITION_TYPE_ABSOLUTE
public	const char*	static, constexpr	POSITION_TYPE_RELATIVE
public	const char*	static, constexpr	BACKGROUND_COLOR_ATTRIBUTE_NAME
public	const char*	static, constexpr	BACKGROUND_COLOR_DEFAULT_COLOR
public	const char*	static, constexpr	BACKGROUND_IMAGE_ATTRIBUTE_NAME
public	const char*	static, constexpr	BACKGROUND_IMAGE_DEFAULT_COLOR
public	const char*	static, constexpr	LINEAR_GRADIENT_KEYWORD
public	const char*	static, constexpr	RADIAL_GRADIENT_KEYWORD
public	const char	static, constexpr	HEX_KEYWORD
public	const char*	static, constexpr	RGB_KEYWORD
public	const char*	static, constexpr	RGBA_KEYWORD
public	const char*	static, constexpr	FOREGROUND_COLOR_ATTRIBUTE_NAME
public	const char*	static, constexpr	FOREGROUND_COLOR_DEFAULT_COLOR
public	const char*	static, constexpr	OPACITY_ATTRIBUTE_NAME
public	const float	static, constexpr	OPACITY_DEFAULT_VALUE
public	const char*	static, constexpr	FILTER_ATTRIBUTE_NAME
public	const char*	static, constexpr	FILTER_TYPE_NONE
public	const char*	static, constexpr	FILTER_BLUR_KEYWORD
public	const char*	static, constexpr	BACKDROP_FILTER_ATTRIBUTE_NAME
public	const char*	static, constexpr	TRANSFORM_ATTRIBUTE_NAME
public	const char*	static, constexpr	TRANSFORM_TYPE_NONE
public	const char*	static, constexpr	TRANSFORM_TRANSLATE_KEYWORD
public	const char*	static, constexpr	TRANSFORM_TRANSLATE_X_KEYWORD
public	const char*	static, constexpr	TRANSFORM_TRANSLATE_Y_KEYWORD
public	const char*	static, constexpr	TRANSFORM_ROTATE_KEYWORD
public	const char*	static, constexpr	TRANSFORM_SCALE_KEYWORD
public	const char*	static, constexpr	TRANSFORM_SCALE_X_KEYWORD
public	const char*	static, constexpr	TRANSFORM_SCALE_Y_KEYWORD
public	const char*	static, constexpr	TRANSLATE_ATTRIBUTE_NAME
public	const char*	static, constexpr	ROTATE_ATTRIBUTE_NAME
public	const char*	static, constexpr	SCALE_ATTRIBUTE_NAME
public	const char*	static, constexpr	TRANSFORM_ORIGIN_ATTRIBUTE_NAME
public	const char*	static, constexpr	TRANSFORM_ORIGIN_TYPE_LEFT
public	const char*	static, constexpr	TRANSFORM_ORIGIN_TYPE_CENTER
public	const char*	static, constexpr	TRANSFORM_ORIGIN_TYPE_RIGHT
public	const char*	static, constexpr	TRANSFORM_ORIGIN_TYPE_TOP
public	const char*	static, constexpr	TRANSFORM_ORIGIN_TYPE_BOTTOM
public	const char*	static, constexpr	TRANSFORM_DEGREE_UNIT
public	const char*	static, constexpr	TRANSFORM_RADIAN_UNIT
public	const char*	static, constexpr	TRANSFORM_TURN_UNIT
public	const char*	static, constexpr	CORNER_DEFAULT_VALUE
public	const char*	static, constexpr	FONT_FAMILY_ATTRIBUTE_NAME
public	const char*	static, constexpr	FONT_FAMILY_DEFAULT_VALUE
public	const char*	static, constexpr	FONT_SIZE_ATTRIBUTE_NAME
public	const char*	static, constexpr	FONT_SIZE_DEFAULT_VALUE
public	const char*	static, constexpr	FONT_WEIGHT_ATTRIBUTE_NAME
public	const char*	static, constexpr	FONT_WEIGHT_DEFAULT_VALUE
public	const char*	static, constexpr	FONT_WEIGHT_TYPE_NORMAL
public	const char*	static, constexpr	FONT_WEIGHT_TYPE_BOLD
public	const char*	static, constexpr	FONT_WEIGHT_TYPE_BOLDER
public	const char*	static, constexpr	FONT_WEIGHT_TYPE_LIGHTER
public	const float	static, constexpr	FONT_WEIGHT_NORMAL_VALUE
public	const float	static, constexpr	FONT_WEIGHT_BOLD_VALUE
public	const char*	static, constexpr	LETTER_SPACING_ATTRIBUTE_NAME
public	const char*	static, constexpr	TRANSITION_ATTRIBUTE_NAME
public	const char*	static, constexpr	TRANSITION_PROPERTY_ATTRIBUTE_NAME
public	const char*	static, constexpr	TRANSITION_DURATION_ATTRIBUTE_NAME
public	const char*	static, constexpr	TRANSITION_TIMING_FUNCTION_ATTRIBUTE_NAME
public	const char*	static, constexpr	TRANSITION_DELAY_ATTRIBUTE_NAME
public	const char*	static, constexpr	TRANSITION_PROPERTY_ALL
public	const char*	static, constexpr	ANIMATION_ATTRIBUTE_NAME
public	const char*	static, constexpr	ANIMATION_NAME_ATTRIBUTE_NAME
public	const char*	static, constexpr	ANIMATION_DURATION_ATTRIBUTE_NAME
public	const char*	static, constexpr	ANIMATION_TIMING_FUNCTION_ATTRIBUTE_NAME
public	const char*	static, constexpr	ANIMATION_DELAY_ATTRIBUTE_NAME
public	const char*	static, constexpr	ANIMATION_ITERATION_COUNT_ATTRIBUTE_NAME
public	const char*	static, constexpr	ANIMATION_DIRECTION_ATTRIBUTE_NAME
public	const char*	static, constexpr	ANIMATION_FILL_MODE_ATTRIBUTE_NAME
public	const char*	static, constexpr	ANIMATION_PLAY_STATE_ATTRIBUTE_NAME
public	const char*	static, constexpr	ANIMATION_NAME_NONE
public	const char*	static, constexpr	ANIMATION_ITERATION_INFINITE
public	const char*	static, constexpr	ANIMATION_DIRECTION_TYPE_NORMAL
public	const char*	static, constexpr	ANIMATION_DIRECTION_TYPE_REVERSE
public	const char*	static, constexpr	ANIMATION_DIRECTION_TYPE_ALTERNATE
public	const char*	static, constexpr	ANIMATION_DIRECTION_TYPE_ALTERNATE_REVERSE
public	const char*	static, constexpr	ANIMATION_FILL_TYPE_NONE
public	const char*	static, constexpr	ANIMATION_FILL_TYPE_FORWARDS
public	const char*	static, constexpr	ANIMATION_FILL_TYPE_BACKWARDS
public	const char*	static, constexpr	ANIMATION_FILL_TYPE_BOTH
public	const char*	static, constexpr	ANIMATION_PLAY_STATE_TYPE_RUNNING
public	const char*	static, constexpr	ANIMATION_PLAY_STATE_TYPE_PAUSED
public	const char*	static, constexpr	EASING_TYPE_LINEAR
public	const char*	static, constexpr	EASING_TYPE_EASE
public	const char*	static, constexpr	EASING_TYPE_EASE_IN
public	const char*	static, constexpr	EASING_TYPE_EASE_OUT
public	const char*	static, constexpr	EASING_TYPE_EASE_IN_OUT
public	const char*	static, constexpr	EASING_CUBIC_BEZIER_KEYWORD
public	std::vector<String>	static	EASING_TYPES
public	const char*	static, constexpr	KEYFRAMES_KEYWORD
public	const char*	static, constexpr	KEYFRAMES_FROM_KEYWORD
public	const char*	static, constexpr	KEYFRAMES_TO_KEYWORD
public	const char*	static, constexpr	MARGIN_ATTRIBUTE_NAME
public	const char*	static, constexpr	MARGIN_TOP_ATTRIBUTE_NAME
public	const char*	static, constexpr	MARGIN_BOTTOM_ATTRIBUTE_NAME
public	const char*	static, constexpr	MARGIN_LEFT_ATTRIBUTE_NAME
public	const char*	static, constexpr	MARGIN_RIGHT_ATTRIBUTE_NAME
public	const char*	static, constexpr	PADDING_ATTRIBUTE_NAME
public	const char*	static, constexpr	PADDING_TOP_ATTRIBUTE_NAME
public	const char*	static, constexpr	PADDING_BOTTOM_ATTRIBUTE_NAME
public	const char*	static, constexpr	PADDING_LEFT_ATTRIBUTE_NAME
public	const char*	static, constexpr	PADDING_RIGHT_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_WIDTH_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_STYLE_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_COLOR_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_TOP_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_RIGHT_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_BOTTOM_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_LEFT_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_TOP_WIDTH_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_RIGHT_WIDTH_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_BOTTOM_WIDTH_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_LEFT_WIDTH_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_TOP_STYLE_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_RIGHT_STYLE_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_BOTTOM_STYLE_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_LEFT_STYLE_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_TOP_COLOR_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_RIGHT_COLOR_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_BOTTOM_COLOR_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_LEFT_COLOR_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_STYLE_TYPE_NONE
public	const char*	static, constexpr	BORDER_STYLE_TYPE_HIDDEN
public	const char*	static, constexpr	BORDER_STYLE_TYPE_SOLID
public	const char*	static, constexpr	BORDER_STYLE_TYPE_DASHED
public	const char*	static, constexpr	BORDER_STYLE_TYPE_DOTTED
public	const char*	static, constexpr	BORDER_STYLE_TYPE_DOUBLE
public	const char*	static, constexpr	BORDER_STYLE_TYPE_GROOVE
public	const char*	static, constexpr	BORDER_STYLE_TYPE_RIDGE
public	const char*	static, constexpr	BORDER_STYLE_TYPE_INSET
public	const char*	static, constexpr	BORDER_STYLE_TYPE_OUTSET
public	const char*	static, constexpr	BORDER_WIDTH_TYPE_THIN
public	const char*	static, constexpr	BORDER_WIDTH_TYPE_MEDIUM
public	const char*	static, constexpr	BORDER_WIDTH_TYPE_THICK
public	const char*	static, constexpr	GAP_ATTRIBUTE_NAME
public	const char*	static, constexpr	GAP_TOP_ATTRIBUTE_NAME
public	const char*	static, constexpr	GAP_BOTTOM_ATTRIBUTE_NAME
public	const char*	static, constexpr	GAP_LEFT_ATTRIBUTE_NAME
public	const char*	static, constexpr	GAP_RIGHT_ATTRIBUTE_NAME
public	const char*	static, constexpr	ALIGNMENT_ATTRIBUTE_NAME
public	const char*	static, constexpr	ALIGNMENT_TYPE_START
public	const char*	static, constexpr	ALIGNMENT_TYPE_LEFT
public	const char*	static, constexpr	ALIGNMENT_TYPE_CENTER
public	const char*	static, constexpr	ALIGNMENT_TYPE_END
public	const char*	static, constexpr	ALIGNMENT_TYPE_RIGHT
public	const char	static, constexpr	RADIUS_SEPARATOR
public	const char*	static, constexpr	BORDER_RADIUS_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_TOP_LEFT_RADIUS_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_TOP_RIGHT_RADIUS_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_BOTTOM_RIGHT_RADIUS_ATTRIBUTE_NAME
public	const char*	static, constexpr	BORDER_BOTTOM_LEFT_RADIUS_ATTRIBUTE_NAME
public	StyleImport::List		imports
public	StyleProperty<StyleDisplay>		display
public	StyleProperty<float>		zIndex
public	StyleSize		width
public	StyleSize		height
public	StyleFlex		flex
public	StyleProperty<StylePosition>		position
public	StyleProperty<StyleAlignment>		align
public	StyleCorners		margin
public	StyleCorners		padding
public	StyleBorder		border
public	StyleCorners		gap
public	StyleProperty<StyleOverflow>		overflowX
public	StyleProperty<StyleOverflow>		overflowY
public	StyleRadius		radius
public	StyleBackground		background
public	StyleProperty<Color::Rgba>		foregroundColor
public	StyleProperty<float>		opacity
public	StyleFilter		filter
public	StyleFilter		backdrop
public	StyleProperty<StyleTransform>		transform
public	StyleProperty<Vec2>		translate
public	StyleProperty<float>		rotate
public	StyleProperty<Vec2>		scale
public	StyleProperty<Vec2>		transformOrigin
public	StyleFont		font
public	StyleProperty<float>		letterSpacing
public	StyleProperty<WindowCursor>		cursor
public	StyleTransition::List		transitions
public	StyleAnimation		animation
private	const Component*		m_parent
private	AnimatedValues		m_snapshot
private	AnimatedMask		m_snapshotMask
private	Transitions		m_transitionLookup

Style

Grid is the UI system, based on a HTML & CSS systems with a parent relationship between its components.

Types

Constructors

Functions

Members