FREE TRIAL

|

☀
☾
class

UIBlock3D

Inherits from UIBlock

A UIBlock with an adjustable, rounded-corner, rounded-edge cube mesh.

Related Articles
UIBlock3D

Properties

Color

The primary body content color.

CornerRadius

The Length configuration used to calculate a corner radius, applies to all eight corners of the body's front and back faces (XY planes).

EdgeRadius

The Length configuration used to calculate an edge radius, applies to all eight edges of the body's front and back faces (XY planes).

Extension Methods

AddGestureHandler

Subscribe to a gesture event on this UIBlock's descendant hierarchy (inclusive of this UIBlock), filtered to the given ItemVisuals type, TVisuals.

RemoveGestureHandler

Unsubscribe from a gesture event previously subscribed to via AddGestureHandler<TGesture, TVisuals>(UIBlock, UIEventHandler<TGesture, TVisuals>).

Inherited Properties

Alignment

A per-axis alignment for this UIBlock relative to its Parent's bounds (PaddedSize). CalculatedPosition is an offset in the Alignment coordinate space.

AspectRatioAxis

When set to a value other than None, the aspect ratio of this UIBlock's Calculated Size will remain constant, even as Size is modified.

AutoLayout

Position all direct child UIBlocks sequentially along the X, Y, or Z axis.

AutoSize

An AutoSize value for each axis. Provides a way to have this UIBlock's Calculated Size adapt to the size of its Parent or size of its children automatically.

CalculatedCrossSpacing

The calculated output of Cross.Spacing. Calculated by the Nova Engine once per dirty frame and whenenever CalculateLayout() is called explicitly.

CalculatedMargin

The amount of space applied outward from the bounds defined by Rotated Size. Calculated by the Nova Engine once per dirty frame and whenenever CalculateLayout() is called explicitly.

CalculatedPadding

The amount of space applied inward from the bounds defined by Calculated Size. Calculated by the Nova Engine once per dirty frame and whenenever CalculateLayout() is called explicitly.

CalculatedPosition

The local position of the UIBlock, offset from its configured Alignment. Calculated by the Nova Engine once per dirty frame and whenenever CalculateLayout() is called explicitly.

CalculatedSize

The size of the UIBlock. Calculated by the Nova Engine once per dirty frame and whenenever CalculateLayout() is called explicitly.

CalculatedSpacing

The calculated output of Spacing. Calculated by the Nova Engine once per dirty frame and whenenever CalculateLayout() is called explicitly.

ChildBounds

The total UnityEngine.Bounds of this UIBlock's immediate children in local space.

ChildCount

The number of enabled child UnityEngine.GameObject's with a UIBlock component.

GameObjectLayer

Sets the GameObject's layer. Should be used instead of gameobject.layer to ensure that Nova is tracking the new layer.

HierarchyBounds

The total UnityEngine.Bounds of this UIBlock's hierarchy, inclusive of all decendent HierarchyBounds, in local space.

Layout

The entire set of uncalculated UIBlock layout properties.

LayoutSize

The final, unscaled size of this UIBlock in its Parent's local space, used for positioning.
Equivalent to RotatedSize + CalculatedMargin.Size.

Margin

The LengthBounds configuration used to calculate CalculatedMargin. Describes a spatial buffer applied outward from Calculated Size.

MarginMinMax

The MinMaxBounds used to clamp Margin when calculating Calculated Margin.

PaddedSize

Equivalent to CalculatedSize - CalculatedPadding.Size.

Padding

The LengthBounds configuration used to calculate Calculated Padding. Describes a spatial buffer applied inward from Calculated Size.

PaddingMinMax

The MinMaxBounds used to clamp Padding when calculating Calculated Padding.

Parent

The UIBlock on transform.parent. If transform.parent is null or there is no UIBlock on transform.parent, this value will be null.

Position

The Length3 configuration used to calculate Calculated Position. Describes a per-axis offset from its Alignment.

PositionMinMax

The MinMax3 used to clamp Position when calculating Calculated Position.

Root

The root of this UIBlock's connected UIBlock hierarchy.

RotateSize

If true, the Layout Size will account for the bounds of Calculated Size rotated by UnityEngine.Transform.localRotation.
If false, the UIBlock will still render rotated, but the Layout Size will not account for UnityEngine.Transform.localRotation.

RotatedSize

If Rotate Size is true, returns Calculated Size rotated by UnityEngine.Transform.localRotation.
If Rotate Size is false, returns Calculated Size.

Size

The Length3 configuration used to calculate Calculated Size.

SizeMinMax

The MinMax3 used to clamp Size and Auto Size when calculating CalculatedSize..

Surface

The Surface configuration for this UIBlock, adjusts the mesh surface's appearance under scene lighting.

Visible

Specifies whether any visual properties should render.

Inherited Methods

AddGestureHandler Subscribe to a gesture event on this UIBlock and optionally on its descendent hierarchy, depending on the value of includeHierarchy.
CalculateLayout

The Nova Engine will automatically process all modified layout properties at the end of each frame. However, some UI scenarios may require knowing the Calculated Size or another calculated layout value intra-frame, before the Nova Engine has had a chance to run. Calling this method will force an inline recalculation of all modified layout properties on this UIBlock.

FireGestureEvent Fire a gesture event on this UIBlock.
GetChild

Retrieves the child UIBlock at the provided index.

RemoveGestureHandler Unsubscribe from a gesture event previously subscribed to via AddGestureHandler<TGesture>(UIEventHandler<TGesture>, Boolean).
TrySetLocalPosition

Move this UIBlock to the given Transform localPosition and update Position accordingly such that when the Nova Engine recalculates the modified layout properties, the resulting transform.localPosition will equal localPosition.

TrySetWorldPosition

Move this UIBlock to the given Transform worldPosition and update Position accordingly such that when the Nova Engine recalculates the modified layout properties, the resulting transform.position will equal worldPosition.

☀
☾
In This Article
Legal EmailContact Github
Copyright © 2022 Supernova Technologies, LLC