PlanarObject

The PlanarObject class describes an object on a plane.

Properties

PropertyDescription

bounds

(get) bounds: Bounds2D (set) (Not Available)

Represents the current 2D bounds relative to the parent element. This is the result of the layout calculation. Values are measured in 3D units.

Note: The SceneObjectBase.transform property doesn't affect the layout, the transformation it specifies is applied on top of it.

height

(get) (Not Available) (set) height: number

Specifies the height of the object.

Note: the specific measurement unit used depends on the context. It will be regular 3D units unless the object is a descendant of a Screen Plane object (2D Canvas) when it will be density-independent pixels.

Note: this parameter is used as an input to the layout algorithm. The layout-calculated size and location of the object is available via PlanarObject.bounds property. The SceneObjectBase.transform property doesn't affect the layout, the transformation it specifies is applied on top of it.

horizontalAlignment

(get) (Not Available) (set) horizontalAlignment: SceneModule.HorizontalAlignment

Specifies the horizontal alignment.

marginBottom

(get) (Not Available) (set) marginBottom: number

Specifies the size of the bottom margin.

Note: it behaves in a similar way to the margin-bottom CSS property.

marginEnd

(get) (Not Available) (set) marginEnd: number

Specifies the size of the right margin.

Note: it behaves in a similar way to the margin-right CSS property.

marginStart

(get) (Not Available) (set) marginStart: number

Specifies the size of the left margin.

Note: it behaves in a similar way to the margin-left CSS property.

marginTop

(get) (Not Available) (set) marginTop: number

Specifies the size of the top margin.

Note: it behaves in a similar way to the margin-top CSS property.

scalingOption

(get) (Not Available) (set) scalingOption: SceneModule.ScalingOption

Specifies the size adjustment relative to parent.

verticalAlignment

(get) (Not Available) (set) verticalAlignment: SceneModule.VerticalAlignment

Specifies the vertical alignment.

width

(get) (Not Available) (set) width: number

Specifies the width of the object.

Note: the specific measurement unit used depends on the context. It will be regular 3D units unless the object is a descendant of a Screen Plane object (2D Canvas) when it will be density-independent pixels.

Note: this parameter is used as an input to the layout algorithm. The layout-calculated size and location of the object is available via PlanarObject.bounds property. The SceneObjectBase.transform property doesn't affect the layout, the transformation it specifies is applied on top of it.

xOffset

(get) (Not Available) (set) xOffset: number

Specifies the horizontal offset of the object.

Note: the specific measurement unit used depends on the context. It will be regular 3D units unless the object is a descendant of a Screen Plane object (2D Canvas) when it will be density-independent pixels.

Note: this parameter is used as an input to the layout algorithm. The layout-calculated size and location of the object is available via PlanarObject.bounds property. The SceneObjectBase.transform property doesn't affect the layout, the transformation it specifies is applied on top of it.

yOffset

(get) (Not Available) (set) yOffset: number

Specifies the vertical offset of the object.

Note: the specific measurement unit used depends on the context. It will be regular 3D units unless the object is a descendant of a Screen Plane object (2D Canvas) when it will be density-independent pixels.

Note: this parameter is used as an input to the layout algorithm. The layout-calculated size and location of the object is available via PlanarObject.bounds property. The SceneObjectBase.transform property doesn't affect the layout, the transformation it specifies is applied on top of it.

Methods

This module exposes no methods.