Class EditorSceneUtility

Contains miscellaneous math helper methods.

Index

Constructors

Methods

calculateBounds calculateBoundsRelativeTo calculateCenter

Constructors

`Protected`constructor

new EditorSceneUtility(isInternalConstructor?: boolean): EditorSceneUtility
Parameters
- OptionalisInternalConstructor: boolean
Returns EditorSceneUtility

Overrides FrameworkObject.constructor

Methods

`Static`calculateBounds

calculateBounds(sceneObject: SceneObject, isChildrenIncluded?: boolean): AABox
Calculates world space bounds of the specified scene object. This will consider components with bounds like Renderable.
Parameters
- sceneObject: SceneObject
  The scene object to calculate the bounds for.
- OptionalisChildrenIncluded: boolean
  If true, children objects will be included in the computation.
Returns AABox
calculateBounds(
sceneObjects: readonly SceneObject[],
isChildrenIncluded?: boolean,
): AABox
Calculates world space bounds of the specified scene objects. This will consider components with bounds like Renderable.
Parameters
- sceneObjects: readonly SceneObject[]
  The scene objects to caclulate the bounds for.
- OptionalisChildrenIncluded: boolean
  If true, children objects will be included in the computation.
Returns AABox

`Static`calculateBoundsRelativeTo

calculateBoundsRelativeTo(
    sceneObject: SceneObject,
    relativeTransform: Immutable<Transform>,
    isChildrenIncluded?: boolean,
): AABox
Calculates bounds of the specified scene object expressed in the local space of relativeTransform. The returned AABB is axis-aligned to relativeTransform's axes (i.e. an OBB expressed in that space). Uses component local bounds directly rather than rotating world-space AABBs for accuracy.
Parameters
- sceneObject: SceneObject
  The scene object to calculate the bounds for.
- relativeTransform: Immutable<Transform>
  World-space transform to calculate the bounds relative to.
- OptionalisChildrenIncluded: boolean
  If true, children objects will be included in the computation.
Returns AABox
calculateBoundsRelativeTo(
    sceneObjects: readonly SceneObject[],
    relativeTransform: Immutable<Transform>,
    isChildrenIncluded?: boolean,
): AABox
Calculates bounds of the specified scene objects expressed in the local space of relativeTransform. The returned AABB is axis-aligned to relativeTransform's axes (i.e. an OBB expressed in that space). Uses component local bounds directly rather than rotating world-space AABBs for accuracy.
Parameters
- sceneObjects: readonly SceneObject[]
  The scene objects to calculate the bounds for.
- relativeTransform: Immutable<Transform>
  World-space transform to calculate the bounds relative to.
- OptionalisChildrenIncluded: boolean
  If true, children objects will be included in the computation.
Returns AABox

`Static`calculateCenter

calculateCenter(sceneObjects: SceneObject[]): Vector3
Calculates world space center of the specified scene objects.
Parameters
- sceneObjects: SceneObject[]
  The scene objects to caclulate the bounds for.
Returns Vector3