API reference

SceneDecorator Class

Extends MonoBehaviour
This class is used to decorate the scene with objects.

Fields

customColliders : Collider[]
Signature
Collider [] customColliders
customTargetTags : string[]
Signature
string [] customTargetTags
DecorateOnStart : MRUK.RoomFilter
Signature
MRUK.RoomFilter DecorateOnStart
recursionLimit : int
Signature
int recursionLimit
sceneDecorations : List< SceneDecoration >
Signature
List<SceneDecoration> sceneDecorations

Static Fields

PI : readonly float
Signature
readonly float PI

Methods

ClearDecorations ()
Clears all decorations from the scene by releasing them back to their respective pools.
Signature
void ClearDecorations()
Returns
void
DecorateScene ()
Decorates all rooms in the scene with scene decorations.
Signature
void DecorateScene()
Returns
void
GenerateOn ( localPos , localPosNormalized , sceneAnchor , sceneDecoration )
Generates a scene decoration at a specific position on an MRUKAnchor.
Signature
void GenerateOn(Vector2 localPos, Vector2 localPosNormalized, MRUKAnchor sceneAnchor, SceneDecoration sceneDecoration)
Parameters
localPos: Vector2  The local position of the decoration on the anchor.
localPosNormalized: Vector2  The normalized local position of the decoration on the anchor.
sceneAnchor: MRUKAnchor  The MRUKAnchor that the decoration will be attached to.
sceneDecoration: SceneDecoration  The scene decoration to be generated.
Returns
void

Inner Interface

IDistribution Interface

Interface for different distributions.

Methods

Distribute ( sceneDecorator , sceneAnchor , sceneDecoration )
Executes the custom distribution.
Signature
void Distribute(SceneDecorator sceneDecorator, MRUKAnchor sceneAnchor, SceneDecoration sceneDecoration)
Parameters
sceneDecorator: SceneDecorator  Which decorator to use.
sceneAnchor: MRUKAnchor  The associated MRUK Anchor.
sceneDecoration: SceneDecoration  The decoration to use
Returns
void