Class ScaledRenderOutputControl

Render output control with content scaling support.

System.Object
Control
ContainerControl
FlaxEngine.GUI.RenderOutputControl
ScaledRenderOutputControl
System.IComparable
Namespace: FlaxEditor.Windows
Assembly: FlaxEngine.CSharp.dll
Syntax
public class ScaledRenderOutputControl : RenderOutputControl, IComparable, IDrawable

Constructors

ScaledRenderOutputControl(SceneRenderTask)

Declaration
public ScaledRenderOutputControl(SceneRenderTask task)
Parameters
SceneRenderTask task

Fields

ContentScale

Custom scale.

Declaration
public float ContentScale
Field Value
System.Single

Properties

ContentSize

Actual bounds size for content (incl. scale).

Declaration
public Float2 ContentSize { get; }
Property Value
Float2

Methods

ContainsPoint(ref Float2, Boolean)

Checks if this control contains given point in local Control Space.

Declaration
public override bool ContainsPoint(ref Float2 location, bool precise = false)
Parameters
Float2 location

Point location in Control Space to check
System.Boolean precise

True if perform precise intersection test against the control content (eg. with hit mask or transparency threshold). Otherwise, only simple bounds-check will be performed.
Returns
System.Boolean

True if point is inside control's area, otherwise false.
Overrides

Draw()

Draw the control and the children.

Declaration
public override void Draw()
Overrides

GetDesireClientArea(out Rectangle)

Gets the desire client area rectangle for all the controls.

Declaration
public override void GetDesireClientArea(out Rectangle rect)
Parameters
Rectangle rect

The client area rectangle for child controls.
Overrides

IntersectsChildContent(Control, Float2, out Float2)

Checks if given point in this container control space intersects with the child control content. Also calculates result location in child control space which can be used to feed control with event at that point.

Declaration
public override bool IntersectsChildContent(Control child, Float2 location, out Float2 childSpaceLocation)
Parameters
Control child

The child control to check.
Float2 location

The location in this container control space.
Float2 childSpaceLocation

The output location in child control space.
Returns
System.Boolean

True if point is over the control content, otherwise false.
Overrides

IntersectsContent(ref Float2, out Float2)

Checks if given location point in Parent Space intersects with the control content and calculates local position.

Declaration
public override bool IntersectsContent(ref Float2 locationParent, out Float2 location)
Parameters
Float2 locationParent

The location in Parent Space.
Float2 location

The location of intersection in Control Space.
Returns
System.Boolean

True if given point in Parent Space intersects with this control content, otherwise false.
Overrides

PointFromParent(ref Float2)

Converts point in parent control coordinates into local control's space.

Declaration
public override Float2 PointFromParent(ref Float2 location)
Parameters
Float2 location

Returns
Float2

The converted point location in control's space.
Overrides

PointToParent(ref Float2)

Converts point in local control's space into parent control coordinates.

Declaration
public override Float2 PointToParent(ref Float2 location)
Parameters
Float2 location

The input location of the point to convert.
Returns
Float2

The converted point location in parent control coordinates.
Overrides

RayCast(ref Float2, out Control)

Performs a raycast against UI controls hierarchy to find any intersecting control content. Uses ContainsPoint(ref Float2, Boolean) with precise check (skips transparent surfaces and empty panels).

Declaration
public override bool RayCast(ref Float2 location, out Control hit)
Parameters
Float2 location

The position to intersect UI with.
Control hit

The result control that intersects with the raycast.
Returns
System.Boolean

True if ray hits any matching control, otherwise false.
Overrides

Extension Methods