One Logo Pool Ball
X
Github
Discord

System

RealityFoundation · IOS API REFERENCE

BindTarget.EntityPath

struct · iOS 15.0+ · SDK 27.1

struct EntityPath

A bind path context for a particular entity. This structure references all the animated properties of an entity. To access the animated properties of one of the entity's children, call ``BindTarget/EntityPath/entity(_:)`` and pass in the child's name.

Members (14)

get · iOS 27.0+

rootMotion

TypeScript
get rootMotion(): BindTarget
Swift declaration
var rootMotion: BindTarget { get }

The root motion bind target for this entity.

method · iOS 18.0+

skeletalPose

TypeScript
skeletalPose(name: string): BindTarget
Swift declaration
func skeletalPose(_ name: SkeletalPose.ID) -> BindTarget
get · iOS 15.0+

jointTransforms

TypeScript
get jointTransforms(): BindTarget
Swift declaration
var jointTransforms: BindTarget { get }

A bind target for the entity's joint transforms.

method · iOS 18.0+

blendShapeWeights

TypeScript
blendShapeWeights(): BindTarget
Swift declaration
func blendShapeWeights() -> BindTarget

A bind target for the entity's blend shape weights.

get · iOS 18.0+

billboardBlendFactor

TypeScript
get billboardBlendFactor(): BindTarget
Swift declaration
var billboardBlendFactor: BindTarget { get }
method · iOS 18.0+

blendShapeWeightsWithID

TypeScript
blendShapeWeightsWithID(id: string): BindTarget
Swift declaration
func blendShapeWeightsWithID(_ id: BlendShapeWeightsData.ID) -> BindTarget
method · iOS 18.0+

blendShapeWeightsAtIndex

TypeScript
blendShapeWeightsAtIndex(index?: number): BindTarget
Swift declaration
func blendShapeWeightsAtIndex(_ index: Int = 0) -> BindTarget
get · iOS 15.0+

self

TypeScript
get self(): BindTarget
Swift declaration
var `self`: BindTarget { get }

A bind target for the entity. This property represents a bind path within an ``AnimationView`` to redirect the view’s ``BlendTreeSourceNode/source`` animation to a different scene.

method · iOS 15.0+

entity

TypeScript
entity(name: string): BindTarget_EntityPath
Swift declaration
func entity(_ name: String) -> BindTarget.EntityPath

Provides a child entity's path. - Parameters: - name: The name of the child entity.

get · iOS 18.0+

opacity

TypeScript
get opacity(): BindTarget
Swift declaration
var opacity: BindTarget { get }

A bind target for the entity's opacity.. Requires that the entity has an OpacityComponent

method · iOS 18.0+

ikSolver

TypeScript
ikSolver(id?: (IKComponent_Solver_ID) | null): BindTarget_IkSolverPath
Swift declaration
func ikSolver(_ id: IKComponent.Solver.ID? = nil) -> BindTarget.IkSolverPath
method · iOS 18.0+

material

TypeScript
material(index: number): BindTarget_MaterialPath
Swift declaration
func material(_ index: Int) -> BindTarget.MaterialPath

Provides a specified material's path. - Parameters: - index: The index of the material.

method · iOS 15.0+

parameter

TypeScript
parameter(name: string): BindTarget
Swift declaration
func parameter(_ name: String) -> BindTarget

Provides a bind target for a particular animated property. - Parameters: - name: The animated property's name.

get · iOS 15.0+

transform

TypeScript
get transform(): BindTarget
Swift declaration
var transform: BindTarget { get }

A bind target for the entity's transform.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →