RealityFoundation · IOS API REFERENCE

BlendTreeBlendNode

struct · iOS 15.0+ · SDK 27.1

struct BlendTreeBlendNode

A source node for an animation that mixes several animations to form a single animation. A _blend tree animation_ mixes multiple animations to form a single animation. The ``BlendTreeBlendNode`` structure adopts the ``BlendTreeNode`` protocol, which specifies the behavior of animations that make up a blend tree animation. This structure adds the ability to branch a blend tree at any point. Each member of this property's ``BlendTreeBlendNode/sources`` array represents a branch in the tree. For more information about blend trees, see ``BlendTreeAnimation``.

Members (9)

get · iOS 15.0+

isAdditive

TypeScript

get isAdditive(): boolean

Swift declaration

var isAdditive: Bool

A Boolean value that indicates whether the animation builds on the current state of the target entity or resets the state before running.

set · iOS 15.0+

isAdditive

TypeScript

set isAdditive(value: boolean)

Swift declaration

var isAdditive: Bool

A Boolean value that indicates whether the animation builds on the current state of the target entity or resets the state before running.

get · iOS 15.0+

name

TypeScript

get name(): string

Swift declaration

var name: String

A textual name for the blend node.

set · iOS 15.0+

name

TypeScript

set name(value: string)

Swift declaration

var name: String

A textual name for the blend node.

get · iOS 15.0+

weight

TypeScript

get weight(): BlendWeight

Swift declaration

var weight: BlendWeight

A normalized percentage that designates how much effect this node has compared to peer nodes.

set · iOS 15.0+

weight

TypeScript

set weight(value: BlendWeight)

Swift declaration

var weight: BlendWeight

A normalized percentage that designates how much effect this node has compared to peer nodes.

init · iOS 15.0+

init

TypeScript

static init(sources: Array<SDKHandle>, name?: string, weight?: BlendWeight, isAdditive?: boolean): BlendTreeBlendNode

Swift declaration

init(sources: [any BlendTreeNode], name: String = "", weight: BlendWeight = .value(1.0), isAdditive: Bool = false)

Creates a tree node made up of multiple branches. - Parameters: - sources: The nodes that branch from this node to form part of a blend tree. - name: A textual name for the node. - weight: A normalized percentage that designates how much this node's animation influences the tree's blended animation. - isAdditive: A Boolean value that indicates whether the animation builds on the current state of the target entity or resets the state before running.

get · iOS 15.0+

sources

TypeScript

get sources(): Array<SDKHandle>

Swift declaration

var sources: [any BlendTreeNode]

The nodes that branch from a node to form part of a blend tree. This node combines the animations of each member of this array to a single animation that represents a _blend_ of the sources. If a source is a ``BlendTreeSourceNode``, this structure blends its animation into the output. If a source is a ``BlendTreeBlendNode``, this structure blends the output of its sources into this structure's output.

set · iOS 15.0+

sources

TypeScript

set sources(value: Array<SDKHandle>)

Swift declaration

var sources: [any BlendTreeNode]

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →