Chunks.Controls.Mask Class Reference

Inheritance diagram for Chunks.Controls.Mask:

Protected Member Functions
override void	OnInitialize ()
	Called only once, when the component is first attached to an entity and is ready to add or retrieve other components. More...
override bool	GetChildBounds (out Bounds bounds)
Protected Member Functions inherited from Chunks.Controls.Image
override void	OnInitialize ()
	Called only once, when the component is first attached to an entity and is ready to add or retrieve other components. More...
Protected Member Functions inherited from Chunks.Controls.Control
override void	OnInitialize ()
	Called only once, when the component is first attached to an entity and is ready to add or retrieve other components. More...
ResourceName	GetResourceName (JToken token)
	Converts a json token to a resource name, associating it with the current namespace. Only valid from within OnReadJson. More...
virtual void	OnChildLoadedFromLayout (Control child)
	Invoked when a new child is created as specified by a json layout object. More...
virtual void	OnLayoutLoaded (bool firstTime)
	Invoked when the control's layout has been (re)loaded. More...
override void	OnUpdate ()
	Called once per world update if this component and its parent entity are enabled. More...
virtual void	OnPointerEnter (PointerEventArgs e)
virtual void	OnPointerLeave (PointerEventArgs e)
virtual void	OnPointerClick (PointerEventArgs e)
virtual void	OnPointerPress (PointerEventArgs e)
virtual void	OnPointerRelease (PointerEventArgs e)
virtual void	OnPointerBeginDrag (PointerEventArgs e)
virtual void	OnPointerEndDrag (PointerEventArgs e)
virtual void	OnPointerDrag (PointerEventArgs e)
virtual void	OnPointerScroll (PointerEventArgs e)
string	GetSubstitutedText (string format)
virtual void	OnUpdateTextSubstitutions ()

Properties
bool	ShowMaskImage [get, set]
Properties inherited from Chunks.Controls.Image
Color	Color [get, set]
	Color of the Panel. More...
ImageType	Type [get, set]
bool	PreserveAspect [get, set]
Graphics.Texture	Texture [get, set]
Graphics.Sprite	Sprite [get, set]
Properties inherited from Chunks.Controls.Control
MenuPanel	MenuPanel [get, set]
PointerEventHandler	PointerEntered
PointerEventHandler	PointerLeft
PointerEventHandler	PointerClicked
PointerEventHandler	PointerPressed
PointerEventHandler	PointerReleased
PointerEventHandler	PointerBeginDragging
PointerEventHandler	PointerEndDragging
PointerEventHandler	PointerDragging
PointerEventHandler	PointerScrolling

Additional Inherited Members
Public Member Functions inherited from Chunks.Controls.Control
	Control ()
TControl	CreateChildControl< TControl > ()
	Creates a new Entity as a child of this one with an instance of the given Control type attached to it, which is returned. More...
Control	CreateChildControl (Type type)
	Creates a new Entity as a child of this one with an instance of the given Control type attached to it, which is returned. More...
Control	CreateChildControl (ResourceName resName)
	Creates a new Entity as a child of this one with a Control attached to it, as defined by the control layout resource specified by the given resource name. More...
Bounds	GetChildBounds ()
delegate void	PointerEventHandler (Control sender, PointerEventArgs e)
void	SetTextSubstitution (string key, string value)
string	GetTextSubstitution (string key)
Public Attributes inherited from Chunks.Controls.Control
new ControlTransform	Transform => (ControlTransform) base.Transform
	The transformation of the entity this instance is attached to. More...
Protected Attributes inherited from Chunks.Controls.Image
override bool	IncludeSelfInBounds => true
Protected Attributes inherited from Chunks.Controls.Control
virtual bool	IncludeSelfInBounds => false

Member Function Documentation

override bool Chunks.Controls.Mask.GetChildBounds ( out Bounds  bounds )

protectedvirtual

Reimplemented from Chunks.Controls.Control.

override void Chunks.Controls.Mask.OnInitialize ( )

protected

Called only once, when the component is first attached to an entity and is ready to add or retrieve other components.

Property Documentation

bool Chunks.Controls.Mask.ShowMaskImage

getset

---

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

• Source/Chunks/Controls/Mask.cs