RootViewport Class - Fuse Documentation

Jump to:
Table of Contents

Location

Namespace: Fuse
Package: Fuse.Nodes 2.9.1

Show Uno properties and methods

Interface of RootViewport

PointToWorldRay(float2) : Ray uno

ProjectionTransform : float4x4 uno

ProjectionTransformInverse : float4x4 uno

Resized : Action<float2> (float2) ux

RestorePreviewState(object) uno

Sets the current state to restore (may be null). This must be called prior to adding any children. The state contained here will only be used once. Each time a state must be restored SavePreviewState and PreviewSetState should be called again.

RootViewport(Window, float) Constructor uno

SavePreviewState : object uno

Returns an opaque object of the saved state for preview. This is neither a serialized nor cloned state; it can be used only once in RestorePreviewState

Size : float2 uno

ViewOrigin : float3 uno

ViewProjectionTransform : float4x4 uno

ViewProjectionTransformInverse : float4x4 uno

ViewRange : float2 uno

ViewTransform : float4x4 uno

ViewTransformInverse : float4x4 uno

Window : Window uno

WorldToLocalRay(IViewport, Ray, Visual) : Ray uno

Inherited from Visual

AbsoluteViewportOrigin : float2 uno

Returns the origin of this Visual in the viewport (world) space.

AbsoluteZoom : float uno

Add(Node) uno

AddDrawCost(double) uno

ArrangeMarginBox(float2, LayoutParams) : float2 uno

BeginInteraction(object, Action) uno

BeginRemoveChild(Node, Action<Node> (Node)) uno

Begins removing a given node, playing all RemovedAnimations before actual removal.

BeginRemoveVisual(Visual, Action<Node> (Node)) uno

Begins removing a given visual, playing all RemovedAnimations before actual removal.

BringIntoView uno

bringIntoView() js

Requests that this visual be brought into the visible are of the screen. Typically a containing ScrollView will scroll to ensure it is visible.

BringToFront(Visual) uno

Brings the given child to the front of the Z-order. In UX markup, use the BringToFront trigger action instead.

CancelInteractions(CancelInteractionsType) uno

ChildCount : int uno

The number of child nodes of this visual.

Children : IList of Node ux

The children of the visual. All nodes placed inside the visual in UX markup are assigned to this list. The order of Visuals this list determines the order of layout. The Z-order of the children is by default equal to this order, but can be manipulated separately using methods like BringToFront and SendToBack.

Draw(DrawContext) uno

DrawCost : double uno

EndInteraction(object) uno

FindTemplate(string) : Template uno

FindViewport : IViewport uno

FirstChild<T> : T uno

Returns the first child node of the given type.

GetHitWindowPoint(float2) : Visual uno

GetMarginSize(LayoutParams) : float2 uno

GetTransformTo(Visual) : float4x4 uno

GetZOrderChild(int) : Visual uno

Get the Visual for a given z-order

HasChildren : bool uno

HasPendingRemove : bool uno

HasVisualChildren : bool uno

Whether this visual has any visual child nodes.

HitTest(HitTestContext) uno

HitTestBounds : VisualBounds uno

HitTestChildrenBounds : VisualBounds uno

HitTestLocalBounds : VisualBounds uno

IfSnap(float2) : float2 uno

IfSnapDown(float2) : float2 uno

IfSnapUp(float2) : float2 uno

Insert(int, Node) uno

InsertAfter(Node, Node) uno

Inserts a child node after the given sibling node.

InvalidateHitTestBounds uno

InvalidateLayout(InvalidateLayoutReason) uno

Indicates that this element requires a new layout as some layout parameters or content have changed.

InvalidateLocalTransform uno

InvalidateRenderBounds uno

Indicates the RenderBounds have changed and need to be recalculated.

InvalidateVisual uno

Indicates the visual for this node has changed. This allows the root-level node to know that it must draw, and any caching that it must invalidate the cache for this node.

InvalidateVisualComposition uno

Indicates the composition of the visual has changed, but that the visual drawing itself is still valid (for example a position change).

IsContextEnabled : bool uno

Whether this node is in an enabled context. The context is disabled if one of the ancestor nodes have IsEnabled set to false.

IsEnabled : bool ux

Whether this node is currently interactable. Disabled visuals do not receive input focus. However, they can still be visible and block hit test for underlaying objects.

IsInteracting : bool uno

IsLocalVisible : bool uno

Returns whether this visual is visible without concern for whether an ancestor visual is hidden or collapsed.

IsMarginBoxDependent(Visual) : LayoutDependent uno

IsVisible : bool uno

Returns whether this visual is currently visible. Will return false if any of the ancestor visuals are hidden or collapsed. This property can not be used to check whether a visual is hidden because it is occluded by another visual, or is outside the view but otherwise visible.

LastChild<T> : T uno

Returns the last child node of the given type.

Layer : Layer ux

The layer this visual belongs to in the Parent container.

LayoutRole : LayoutRole ux

Describes how this visual participates in layout.

LocalBounds : Box uno

LocalRenderBounds : VisualBounds uno

LocalToParent(float2) : float2 uno

Converts a coordinate from the local space into the parent space.

LocalTransform : float4x4 uno

LocalTransformInternal : FastMatrix uno

LocalTransformInverse : float4x4 uno

OnArrangeMarginBox(float2, LayoutParams) : float2 uno

OnBeginRemoveVisual(PendingRemoveVisual) uno

OnChildAdded(Node) uno

OnChildMoved(Node) uno

OnChildRemoved(Node) uno

OnHitTest(HitTestContext) uno

OnInvalidateLayout uno

OnInvalidateRenderBounds : bool uno

OnInvalidateVisual uno

OnInvalidateVisualComposition uno

OnIsContextEnabledChanged uno

OnIsSelectedChanged(bool) uno

OnIsVisibleChanged uno

OnLocalVisibleChanged uno

onParameterChanged(callback) js

Registers a function to be called whenever the routing parameter is changed.

OnPropertyChanged(PropertyObject, Selector) uno

OnRootedPreChildren uno

OnZOrderInvalidated uno

Parameter : string ux

The parameter data for this visual, encoded as JSON, provided by a router if this visual represents a navigation page.

PerformLayout uno

PerformLayout(float2) uno

PrependImplicitTransform(FastMatrix) uno

PrependInverseTransformOrigin(FastMatrix) uno

PrependTransformOrigin(FastMatrix) uno

Remove(Node) : bool uno

RemoveAllChildren<T> uno

Removes all children of the given type.

RemoveDrawCost(double) uno

Resources : IList of Resource ux

The list of resources defined at this node.

SendToBack(Visual) uno

Sends the given child to the back of the Z-order. In UX markup, use the SendToBack trigger action instead.

SetResource(string, object) uno

Snap(float2) : float2 uno

SnapDown(float2) : float2 uno

SnapToPixels : bool ux

Whether to snap the result of layout of this visual to physical device pixels.

SnapUp(float2) : float2 uno

Templates : IList of Template ux

List of templates that will be used to populate this Visual.

TryParentToLocal(float2, float2) : bool uno

Converts a coordinate from the parent space into the local space.

ValidFrameCount : int uno

ViewHandle : ViewHandle uno

Viewport : IViewport uno

VisualChildCount : int uno

The number of child visuals of this visual.

VisualContext : VisualContext uno

WindowToLocal(float2) : float2 uno

WorldPosition : float3 uno

WorldTransform : float4x4 uno

WorldTransformInverse : float4x4 uno

ZOffset : float ux

Specifies a Z-Offset, visuals with higher values are in front of other visuals.

Inherited from Node

Add(Binding) uno

Bindings : IList of Binding ux

The list of bindings belonging to this node.

ContextParent : Node uno

The context parent is the semantic parent of this node. It is where non-UI structure should be resolved, like looking for the DataContext, a Navigation, or other semantic item.

FindByType<T> : T uno

FindNodeByName(Selector, Predicate<Node> (Node)) : Node uno

Finds the first node with a given name that satisfies the given acceptor. The serach algorithm works as follows: Nodes in the subtree are matched first, then it matches the nodes in the subtrees ofthe ancestor nodes by turn all the way to the root. If no matching node is found, the function returns null.

GetNearestAncestorOfType<T> : T uno

Insert(int, Binding) uno

IsRootingCompleted : bool uno

Whether rooting for this node is completed. Returns false if unrooting has started.

IsRootingStarted : bool uno

Whether rooting of this node has started. Note that even if this property returns true, rooting may not yet be completed for the node. See also IsRootingCompleted.

Name : Selector ux

Run-time name of the node. This property is automatically set using the ux:Name attribute.

NextSibling<T> : T uno

Returns the next sibling node of the given type.

OnDataChanged(string, object) uno

OnRooted uno

If you override OnRooted you must call base.OnRooted() first in your derived class. No other processing should happen first, otherwise you might end up in an undefined state.