Header menu logo Nu

AnimatedModelFacetExtensions Module

Type extensions

Type extension Description

this.AnimateBones

Full Usage: this.AnimateBones

Parameters:

TODO: document this!

Extended Type: Entity

world : World

this.AnimatedModel

Full Usage: this.AnimatedModel

Parameters:
    () : unit

Returns: Lens<AnimatedModel AssetTag, Entity>

Extended Type: Entity

() : unit
Returns: Lens<AnimatedModel AssetTag, Entity>

this.AnimatedModel

Full Usage: this.AnimatedModel

Returns: Lens<AnimatedModel AssetTag, Entity>

Extended Type: Entity

Returns: Lens<AnimatedModel AssetTag, Entity>

this.Animations

Full Usage: this.Animations

Parameters:
    () : unit

Returns: Lens<Animation array, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Animation array, Entity>

this.Animations

Full Usage: this.Animations

Returns: Lens<Animation array, Entity>

Extended Type: Entity

Returns: Lens<Animation array, Entity>

this.BoneIdsOpt

Full Usage: this.BoneIdsOpt

Parameters:
    () : unit

Returns: Lens<Dictionary<string, int> option, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Dictionary<string, int> option, Entity>

this.BoneIdsOpt

Full Usage: this.BoneIdsOpt

Returns: Lens<Dictionary<string, int> option, Entity>

Extended Type: Entity

Returns: Lens<Dictionary<string, int> option, Entity>

this.BoneOffsetsOpt

Full Usage: this.BoneOffsetsOpt

Parameters:
    () : unit

Returns: Lens<Matrix4x4 array option, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Matrix4x4 array option, Entity>

this.BoneOffsetsOpt

Full Usage: this.BoneOffsetsOpt

Returns: Lens<Matrix4x4 array option, Entity>

Extended Type: Entity

Returns: Lens<Matrix4x4 array option, Entity>

this.BoneTransformsOpt

Full Usage: this.BoneTransformsOpt

Parameters:
    () : unit

Returns: Lens<Matrix4x4 array option, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Matrix4x4 array option, Entity>

this.BoneTransformsOpt

Full Usage: this.BoneTransformsOpt

Returns: Lens<Matrix4x4 array option, Entity>

Extended Type: Entity

Returns: Lens<Matrix4x4 array option, Entity>

this.DualRenderedSurfaceIndices

Full Usage: this.DualRenderedSurfaceIndices

Parameters:
    () : unit

Returns: Lens<Set<int>, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Set<int>, Entity>

this.DualRenderedSurfaceIndices

Full Usage: this.DualRenderedSurfaceIndices

Returns: Lens<Set<int>, Entity>

Extended Type: Entity

Returns: Lens<Set<int>, Entity>

this.GetAnimatedModel

Full Usage: this.GetAnimatedModel

Parameters:
Returns: AnimatedModel AssetTag

Extended Type: Entity

world : World
Returns: AnimatedModel AssetTag

this.GetAnimations

Full Usage: this.GetAnimations

Parameters:
Returns: Animation array

Extended Type: Entity

world : World
Returns: Animation array

this.GetBoneIdsOpt

Full Usage: this.GetBoneIdsOpt

Parameters:
Returns: Dictionary<string, int> option

Extended Type: Entity

world : World
Returns: Dictionary<string, int> option

this.GetBoneOffsetsOpt

Full Usage: this.GetBoneOffsetsOpt

Parameters:
Returns: Matrix4x4 array option

Extended Type: Entity

world : World
Returns: Matrix4x4 array option

this.GetBoneTransformsOpt

Full Usage: this.GetBoneTransformsOpt

Parameters:
Returns: Matrix4x4 array option

Extended Type: Entity

world : World
Returns: Matrix4x4 array option

this.GetDualRenderedSurfaceIndices

Full Usage: this.GetDualRenderedSurfaceIndices

Parameters:
Returns: Set<int>

Extended Type: Entity

world : World
Returns: Set<int>

this.GetSubsortOffsets

Full Usage: this.GetSubsortOffsets

Parameters:
Returns: Map<int, single>

Extended Type: Entity

world : World
Returns: Map<int, single>

this.GetUseJobGraph

Full Usage: this.GetUseJobGraph

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.SetAnimatedModel

Full Usage: this.SetAnimatedModel

Parameters:

Extended Type: Entity

value : AnimatedModel AssetTag
world : World

this.SetAnimations

Full Usage: this.SetAnimations

Parameters:

Extended Type: Entity

value : Animation array
world : World

this.SetBoneIdsOpt

Full Usage: this.SetBoneIdsOpt

Parameters:

Extended Type: Entity

value : Dictionary<string, int> option
world : World

this.SetBoneOffsetsOpt

Full Usage: this.SetBoneOffsetsOpt

Parameters:

Extended Type: Entity

value : Matrix4x4 array option
world : World

this.SetBoneTransformsFast

Full Usage: this.SetBoneTransformsFast

Parameters:
    boneIds : 'a
    boneOffsets : 'b
    boneTransforms : 'c
    world : World

Set the bone transforms via a fast path. OPTIMIZATION: this function sets these properties without comparison or events. Unfortunately, F# forces array value equality on us. Because this function elides change detection and thus the equality check, it runs much faster than setting the BoneOffsets and BoneTransform properties normally.

Extended Type: Entity

boneIds : 'a
boneOffsets : 'b
boneTransforms : 'c
world : World

this.SetBoneTransformsOpt

Full Usage: this.SetBoneTransformsOpt

Parameters:

Extended Type: Entity

value : Matrix4x4 array option
world : World

this.SetDualRenderedSurfaceIndices

Full Usage: this.SetDualRenderedSurfaceIndices

Parameters:

Extended Type: Entity

value : Set<int>
world : World

this.SetSubsortOffsets

Full Usage: this.SetSubsortOffsets

Parameters:
    value : Map<int, single>
    world : World

Extended Type: Entity

value : Map<int, single>
world : World

this.SetUseJobGraph

Full Usage: this.SetUseJobGraph

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SubsortOffsets

Full Usage: this.SubsortOffsets

Parameters:
    () : unit

Returns: Lens<Map<int, single>, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Map<int, single>, Entity>

this.SubsortOffsets

Full Usage: this.SubsortOffsets

Returns: Lens<Map<int, single>, Entity>

Extended Type: Entity

Returns: Lens<Map<int, single>, Entity>

this.TryComputeBoneTransforms

Full Usage: this.TryComputeBoneTransforms

Parameters:
Returns: (Dictionary<string, int32> * Matrix4x4 array * Matrix4x4 array) option

Attempt to compute the bone transforms (and related data) using the given time and animation data.

Extended Type: Entity

time : GameTime
animations : Animation array
sceneOpt : Scene option
Returns: (Dictionary<string, int32> * Matrix4x4 array * Matrix4x4 array) option

this.TryGetBoneTransformByIndex

Full Usage: this.TryGetBoneTransformByIndex

Parameters:
    boneIndex : int
    world : World

Returns: Matrix4x4 option

Attempt to get the bone ids, offsets, and transforms from an entity that supports boned models.

Extended Type: Entity

boneIndex : int
world : World
Returns: Matrix4x4 option

this.TryGetBoneTransformByName

Full Usage: this.TryGetBoneTransformByName

Parameters:
    boneName : string
    world : World

Returns: Matrix4x4 option

Attempt to get the bone ids, offsets, and transforms from an entity that supports boned models.

Extended Type: Entity

boneName : string
world : World
Returns: Matrix4x4 option

this.UseJobGraph

Full Usage: this.UseJobGraph

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.UseJobGraph

Full Usage: this.UseJobGraph

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

Type something to start searching.