RTTextureWidget Interface Reference

Inheritance diagram for RTTextureWidget:

Public Member Functions
proto external void	SetGUIWidget (IEntity ent, int rtIndex)
	[DEPRECATED] Sets Widget of type RTTextureWidgetTypeID, to which it is possible to reference in shader as $rendertarget.
proto external void	SetRenderTarget (IEntity ent)
	Sets this widget instance (of type RTTextureWidgetTypeID) as render resource which can be referenced in material as $rendertarget.
proto external void	RemoveRenderTarget (IEntity ent)
	Removes this widget instance (of type RTTextureWidgetTypeID) as render resource from the entity's mesh object.
proto external void	SetRenderView (IEntity ent, int cameraIndex)
	Sets Widget of type RTTextureWidgetTypeID, to which it is possible to reference in shader as $renderview It is possible to use only after object selection.
Public Member Functions inherited from Widget
proto external void	Update ()
proto external Widget	GetParent ()
	Returns parent in hierarchy, or nullptr.
proto external Widget	GetChildren ()
	Returns children in hierarchy, or nullptr.
proto external Widget	GetSibling ()
	Returns next sibling in hierarchy, or nullptr.
proto external void	RemoveChild (notnull Widget child)
proto external void	SetName (string name)
proto external string	GetName ()
proto external void	SetUserID (int id)
	Sets user ID.
proto external int	GetUserID ()
	Gets user ID.
proto external bool	IsFocusable ()
proto external void	AddChild (notnull Widget child)
	Adds given widget as a child. Possible only if this widget accepts more children.
proto external void	AddHandler (ScriptedWidgetEventHandler eventHandler)
	Add (hook) handler to widget. Adds reference to the handler.
proto external void	RemoveHandler (ScriptedWidgetEventHandler eventHandler)
	Unhook handler from widget. Release reference to the handler.
proto external int	GetNumHandlers ()
	Return number of all handlers attached to widget (C++ & scripted)
proto external ScriptedWidgetEventHandler	GetHandler (int index)
	return widget event handler on given index, when the event handler is not inherited from ScriptedWidgetEventHandler, null is returned
proto external ScriptedWidgetEventHandler	FindHandler (TypeName type)
	return first widget event handler of given type, when none of event handlers has the type null is returned
proto external void	SetVisible (bool show)
	Sets visibility of this widget (VISIBLE flag)
proto external void	SetEnabled (bool enable)
	Sets enabled state of this widget (DISABLED flag)
proto external bool	IsVisible ()
	Returns whether is this widget visible (VISIBLE flag is set)
proto external bool	IsVisibleInHierarchy ()
	Returns whether are this widget and all its ancesstors visible (VISIBLE flag is set)
proto external bool	IsEnabled ()
	Returns whether is this widget enabled (DISABLED flag is not set)
proto external bool	IsEnabledInHierarchy ()
	Returns whether are this widget and all its ancesstors enabled (DISABLED flag is not set)
proto external bool	IsClippingChildren ()
	Returns wheter this widget clips its children.
proto external bool	GetIsColorInherited ()
proto external void	SetIsColorInherited (bool isColorInherited)
	Sets whether this widget inherits color from its parent.
proto external void	SetColor (notnull Color color)
	Sets color of this widget.
proto external void	SetColorInt (int color)
	Set ARGB color.
proto external int	GetColorInt ()
proto external void	SetOpacity (float alpha)
	Sets opacity which applies to this widget and all its descendants.
proto external float	GetOpacity ()
proto external void	SetZOrder (int zOrder)
	Changes z-order value.
proto external int	GetZOrder ()
	Higher values mean more in front.
proto external void	RemoveFromHierarchy ()
	Removes this widget from its parent and from the WidgetManager.
proto external Widget	FindWidget (string pathname)
	Find Widget by path. e.g FindWidget("widget1.widget2.widget3.mywidget")
proto external Widget	FindAnyWidget (string pathname)
	Looks for a widget with given name in this widget's children.
proto external Widget	FindAnyWidgetById (int user_id)
	Find Widget by userID.
proto external string	GetStyleName ()
proto external WorkspaceWidget	GetWorkspace ()
proto ref Color	GetColor ()
	Returns color of this widget.
proto string	GetNavigation (WidgetNavigationDirection direction, out WidgetNavigationRuleType rule)
	Gets navigation rule for given direction.
proto external void	SetNavigation (WidgetNavigationDirection direction, WidgetNavigationRuleType rule, string explicitTarget=string.Empty)
	Sets navigation rule for given direction.
proto external string	GetTypeName ()
proto external int	GetFlags ()
proto external int	SetFlags (int flags)
	Sets given WidgetFlags for this widget.
proto external int	ClearFlags (int flags)
	Removes all flags.
proto external WidgetType	GetTypeID ()
proto void	GetScreenPos (out float x, out float y)
	Returns position of this widget's top left corner in DPI scaled resolution.
proto void	GetScreenSize (out float width, out float height)
	Returns size of this widget in DPI scaled resolution.
proto external bool	RemoveCallback (int eventId, int callbackId)
	Remove callback with given callbackId (callback ID is returned from AddCallback method)
proto external bool	RemoveCallbackByOwner (int eventId, Class owner)
	Remove callback with given caller object (in case the callback method is on object instance)
proto external bool	EmitCallback (int eventId)
	Trigger callbacks attached to eventID on the widget (not called over hierarchy)
proto int	AddCallback (int eventId, WidgetEventCallback fn)
	Add callback for given event id and returns callback id.
Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Member Function Documentation

RemoveRenderTarget()

proto external void RTTextureWidget.RemoveRenderTarget

(

IEntity

ent

)

Removes this widget instance (of type RTTextureWidgetTypeID) as render resource from the entity's mesh object.

Must be called when destroying the widget.

SetGUIWidget()

proto external void RTTextureWidget.SetGUIWidget	(	IEntity	ent,
		int	rtIndex )

[DEPRECATED] Sets Widget of type RTTextureWidgetTypeID, to which it is possible to reference in shader as $rendertarget.

It is possible to use only after object selection. When selecting another object, it is necessary to set GUI widget again.

Currently index of render target is not used and zero index is always assigned in the case the index is below 4 (this is the maximum internal render targets amount). Otherwise the rt is deleted from entity object component - usually should be called in this manner (e.g. rtIndex = -1) when the widget RT is destroyed.

SetRenderTarget()

proto external void RTTextureWidget.SetRenderTarget

(

IEntity

ent

)

Sets this widget instance (of type RTTextureWidgetTypeID) as render resource which can be referenced in material as $rendertarget.

It is possible to use only after object selection. When selecting another object, it is necessary to set the render target again. When destroying the widget, use RemoveRenderTarget(IEntity ent) to remove the render target from the entity's mesh object.

SetRenderView()

proto external void RTTextureWidget.SetRenderView	(	IEntity	ent,
		int	cameraIndex )

Sets Widget of type RTTextureWidgetTypeID, to which it is possible to reference in shader as $renderview It is possible to use only after object selection.

When selecting another object, it is necessary to set widget again.

Camera index should be set to the camera that is used for rendering in this render target, set it to -1 if you are destroying the widget.

---

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

• Core/generated/UI/RTTextureWidget.c