makeIterator
TypeScriptmakeIterator(): MeshBuffer_Iterator<unknown>func makeIterator() -> MeshBuffer<Element>.IteratorReturns an iterator over the elements of this sequence.
Additional SDK Modules · IOS API REFERENCE
RealityFoundation
Explore RealityFoundation types and the APIs available through One's generated iOS bindings.
995 types
4,002 callable entries
190 skipped
95% entry coverage
Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.
Types
AccessibilityComponent
struct · iOS 17.0+
AccessibilityComponent.CustomContent
struct · iOS 17.0+
AccessibilityComponent.SupportedActions
struct · iOS 17.0+
AccessibilityComponent.SupportedActions.ArrayLiteralElement
typealias · iOS 17.0+
AccessibilityComponent.SupportedActions.Element
typealias · iOS 17.0+
AccessibilityComponent.SupportedActions.RawValue
typealias · iOS 17.0+
ActionAnimation
struct · iOS 18.0+
ActionAnimation.EventDefinitionType
typealias · iOS 18.0+
ActionAnimation.EventParameterType
typealias · iOS 18.0+
ActionEntityResolution
enum · iOS 18.0+
ActionEvent
struct · iOS 18.0+
ActionEventDefinition
struct · iOS 18.0+
ActionEventDefinition.EventParameterType
typealias · iOS 18.0+
ActionEventType
struct · iOS 18.0+
ActionEventType.ArrayLiteralElement
typealias · iOS 18.0+
ActionEventType.Element
typealias · iOS 18.0+
ActionEventType.RawValue
typealias · iOS 18.0+
ActionHandlerProtocol
protocol · iOS 18.0+
ActionHandlerProtocol.EventType
typealias · iOS 18.0+
ActionResult
enum · iOS 27.0+
AdaptiveResolutionComponent
struct · iOS 18.0+
AmbientAudioComponent
struct · iOS 18.0+
AnchorEntity
class · iOS 13.0+
AnchoringComponent
struct · iOS 13.0+
AnchoringComponent.ImageAnchoringSource
struct · iOS 18.0+
AnchoringComponent.ObjectAnchoringSource
struct · iOS 18.0+
AnchoringComponent.PhysicsSimulation
enum · iOS 18.0+
AnchoringComponent.Target
enum · iOS 13.0+
AnchoringComponent.Target.Alignment
struct · iOS 13.0+
AnchoringComponent.Target.Alignment.ArrayLiteralElement
typealias · iOS 13.0+
AnchoringComponent.Target.Alignment.Element
typealias · iOS 13.0+
AnchoringComponent.Target.Alignment.RawValue
typealias · iOS 13.0+
AnchoringComponent.Target.Classification
struct · iOS 13.0+
AnchoringComponent.Target.Classification.ArrayLiteralElement
typealias · iOS 13.0+
AnchoringComponent.Target.Classification.Element
typealias · iOS 13.0+
AnchoringComponent.Target.Classification.RawValue
typealias · iOS 13.0+
AnchoringComponent.TrackingMode
struct · iOS 18.0+
AnchorStateEvents
enum · iOS 26.0+
AnchorStateEvents.DidAnchor
struct · iOS 26.0+
AnchorStateEvents.DidAnchor.Reason
enum · iOS 26.0+
AnchorStateEvents.DidFailToAnchor
struct · iOS 26.0+
AnchorStateEvents.DidFailToAnchor.Reason
enum · iOS 26.0+
AnchorStateEvents.WillUnanchor
struct · iOS 26.0+
AnchorStateEvents.WillUnanchor.Reason
enum · iOS 26.0+
AnimatableData
protocol · iOS 15.0+
AnimationDefinition
protocol · iOS 15.0+
AnimationEvents
enum · iOS 13.0+
AnimationEvents.PlaybackCompleted
struct · iOS 13.0+
AnimationEvents.PlaybackLooped
struct · iOS 13.0+
AnimationEvents.PlaybackStarted
struct · iOS 18.0+
AnimationEvents.PlaybackTerminated
struct · iOS 13.0+
AnimationEvents.RootMotionDidUpdate
struct · iOS 27.0+
AnimationEvents.SkeletalPoseUpdateComplete
struct · iOS 18.0+
AnimationFillMode
struct · iOS 15.0+
AnimationFillMode.ArrayLiteralElement
typealias · iOS 15.0+
AnimationFillMode.Element
typealias · iOS 15.0+
AnimationFillMode.RawValue
typealias · iOS 15.0+
AnimationGraphComponent
struct · iOS 27.0+
AnimationGraphComponent.ActiveClipNode
struct · iOS 27.0+
AnimationGraphComponent.ActiveClipNode.ID
typealias · iOS 27.0+
AnimationGraphComponent.ActiveNode
protocol · iOS 27.0+
AnimationGraphComponent.ActiveStateMachineNode
struct · iOS 27.0+
AnimationGraphComponent.ActiveStateMachineNode.ID
typealias · iOS 27.0+
AnimationGraphComponent.ActiveTag
struct · iOS 27.0+
AnimationGraphComponent.ActiveTag.ID
typealias · iOS 27.0+
AnimationGraphResource
class · iOS 27.0+
AnimationGroup
struct · iOS 15.0+
AnimationHandoffType
struct · iOS 18.0+
AnimationLibraryComponent
struct · iOS 18.0+
AnimationLibraryComponent.AnimationCollection
struct · iOS 18.0+
AnimationLibraryComponent.AnimationCollection.Element
typealias · iOS 18.0+
AnimationLibraryComponent.AnimationCollection.Index
struct · iOS 18.0+
AnimationLibraryComponent.AnimationCollection.Indices
typealias · iOS 18.0+
AnimationLibraryComponent.AnimationCollection.Iterator
struct · iOS 18.0+
AnimationLibraryComponent.AnimationCollection.Iterator.Element
typealias · iOS 18.0+
AnimationLibraryComponent.AnimationCollection.SubSequence
typealias · iOS 18.0+
AnimationLibraryComponent.Key
typealias · iOS 18.0+
AnimationLibraryComponent.Value
typealias · iOS 18.0+
AnimationPlaybackController
class · iOS 13.0+
AnimationRepeatMode
enum · iOS 15.0+
AnimationResource
class · iOS 13.0+
AnimationState
struct · iOS 18.0+
AnimationState.ValueType
typealias · iOS 18.0+
AnimationStateProtocol
protocol · iOS 18.0+
AnimationTimingFunction
struct · iOS 13.0+
AnimationView
struct · iOS 15.0+
AntialiasingMode
enum · iOS 18.0+
AnyMeshBuffer
struct · iOS 15.0+
AttachedTransformComponent
struct · iOS 26.0+
Audio
enum · iOS 18.0+
Audio.Absorption
struct · iOS 27.0+
Audio.Absorption.Key
typealias · iOS 27.0+
Audio.Absorption.Value
typealias · iOS 27.0+
Audio.Decibel
typealias · iOS 18.0+
Audio.Directivity
enum · iOS 18.0+
Audio.DistanceAttenuation
enum · iOS 18.0+
Audio.GeneratorRenderHandler
typealias · iOS 18.0+
Audio.Material
struct · iOS 27.0+
Audio.Scattering
struct · iOS 27.0+
Audio.Scattering.Key
typealias · iOS 27.0+
Audio.Scattering.Value
typealias · iOS 27.0+
AudioBufferResource
class · iOS 15.0+
AudioBufferResource.Configuration
struct · iOS 18.0+
AudioEvents
enum · iOS 13.0+
AudioEvents.PlaybackCompleted
struct · iOS 13.0+
AudioEvents.PlaybackGroupCompleted
struct · iOS 27.0+
AudioFileGroupResource
class · iOS 18.0+
AudioFileResource
class · iOS 13.0+
AudioFileResource.Configuration
struct · iOS 18.0+
AudioFileResource.LoadingStrategy
enum · iOS 13.0+
AudioFileResource.LoadingStrategy.RawValue
typealias · iOS 18.0+
AudioGeneratorConfiguration
struct · iOS 18.0+
AudioGeneratorController
class · iOS 18.0+
AudioLibraryComponent
struct · iOS 18.0+
AudioLibraryComponent.Key
typealias · iOS 18.0+
AudioLibraryComponent.Value
typealias · iOS 18.0+
AudioMixGroup
struct · iOS 18.0+
AudioMixGroupsComponent
struct · iOS 18.0+
AudioPlaybackController
class · iOS 13.0+
AudioPlaybackController.Decibel
typealias · iOS 13.0+ · Deprecated in iOS 18.0
AudioPlaybackController.ID
typealias · iOS 13.0+
AudioPlaybackGroupController
class · iOS 27.0+
AudioPlaybackGroupController.ID
typealias · iOS 27.0+
AudioResource
class · iOS 13.0+
AudioResource.Calibration
struct · iOS 18.0+
AudioResource.InputMode
enum · iOS 13.0+ · Deprecated in iOS 16.3
AudioResource.Normalization
struct · iOS 18.0+
BehaviorTreeAction
protocol · iOS 27.0+
BehaviorTreeActionHandler
protocol · iOS 27.0+
BehaviorTreeComponent
struct · iOS 27.0+
BehaviorTreeResource
class · iOS 27.0+
BillboardAction
struct · iOS 18.0+
BillboardAction.EventParameterType
typealias · iOS 18.0+
BillboardAction.Transition
struct · iOS 18.0+
BillboardComponent
struct · iOS 18.0+
BindableData
protocol · iOS 15.0+
BindableValue
struct · iOS 15.0+
BindableValuesReference
struct · iOS 15.0+
BindPath
struct · iOS 15.0+
BindPath.Part
enum · iOS 15.0+
BindTarget
enum · iOS 15.0+
BindTarget.EntityPath
struct · iOS 15.0+
BindTarget.IkSolverPath
struct · iOS 18.0+
BindTarget.MaterialPath
struct · iOS 18.0+
BindTarget.ScenePath
struct · iOS 15.0+
BindTarget.TextureCoordinateTransformPath
struct · iOS 18.0+
BlendShapeDeformer
struct · iOS 27.0+
BlendShapeWeights
struct · iOS 18.0+
BlendShapeWeights.ArrayLiteralElement
typealias · iOS 18.0+
BlendShapeWeights.Element
typealias · iOS 18.0+
BlendShapeWeights.Index
typealias · iOS 18.0+
BlendShapeWeights.Indices
typealias · iOS 18.0+
BlendShapeWeights.Iterator
typealias · iOS 18.0+
BlendShapeWeights.SubSequence
typealias · iOS 18.0+
BlendShapeWeightsComponent
struct · iOS 18.0+
BlendShapeWeightsData
struct · iOS 18.0+
BlendShapeWeightsData.ID
typealias · iOS 18.0+
BlendShapeWeightsMapping
class · iOS 18.0+
BlendShapeWeightsSet
struct · iOS 18.0+
BlendShapeWeightsSet.Element
typealias · iOS 18.0+
BlendShapeWeightsSet.Index
typealias · iOS 18.0+
BlendShapeWeightsSet.Indices
typealias · iOS 18.0+
BlendShapeWeightsSet.Iterator
struct · iOS 18.0+
BlendShapeWeightsSet.Iterator.Element
typealias · iOS 18.0+
BlendShapeWeightsSet.SubSequence
typealias · iOS 18.0+
BlendTreeAnimation
struct · iOS 15.0+
BlendTreeBlendNode
struct · iOS 15.0+
BlendTreeInvalidNode
struct · iOS 15.0+
BlendTreeNode
protocol · iOS 15.0+
BlendTreeSourceNode
struct · iOS 15.0+
BlendWeight
enum · iOS 15.0+
BloomComponent
struct · iOS 27.0+
BloomComponent.BloomScope
struct · iOS 27.0+
BloomOptionsComponent
struct · iOS 27.0+
BodyTrackedEntity
class · iOS 13.0+
BodyTrackingComponent
struct · iOS 13.0+
BodyTrackingComponent.Target
enum · iOS 13.0+
BoundingBox
struct · iOS 13.0+
BoundingBoxCalculator
struct · iOS 27.0+
CameraControls
struct · iOS 18.0+
CameraFieldOfViewOrientation
enum · iOS 18.0+
CameraRealityCoordinateSpace
struct · iOS 18.0+
ChannelAudioComponent
struct · iOS 18.0+
CharacterControllerComponent
struct · iOS 15.0+
CharacterControllerComponent.Collision
struct · iOS 15.0+
CharacterControllerComponent.CollisionFlags
struct · iOS 15.0+
CharacterControllerComponent.CollisionFlags.ArrayLiteralElement
typealias · iOS 15.0+
CharacterControllerComponent.CollisionFlags.Element
typealias · iOS 15.0+
CharacterControllerComponent.CollisionFlags.RawValue
typealias · iOS 15.0+
CharacterControllerStateComponent
struct · iOS 15.0+
ClippingComponent
struct · iOS 27.0+
ClippingComponent.FeatheredEdge
struct · iOS 27.0+
ClippingComponent.FeatheredEdge.Falloff
enum · iOS 27.0+
CollisionCastHit
struct · iOS 13.0+
CollisionCastHit.TriangleHit
struct · iOS 18.0+
CollisionCastQueryType
enum · iOS 13.0+
CollisionComponent
struct · iOS 13.0+
CollisionComponent.CollisionOptions
struct · iOS 18.0+
CollisionComponent.CollisionOptions.ArrayLiteralElement
typealias · iOS 18.0+
CollisionComponent.CollisionOptions.Element
typealias · iOS 18.0+
CollisionComponent.CollisionOptions.RawValue
typealias · iOS 18.0+
CollisionComponent.Mode
enum · iOS 13.0+
CollisionEvents
enum · iOS 13.0+
CollisionEvents.Began
struct · iOS 13.0+
CollisionEvents.Ended
struct · iOS 13.0+
CollisionEvents.Updated
struct · iOS 13.0+
CollisionFilter
struct · iOS 13.0+
CollisionGroup
struct · iOS 13.0+
CollisionGroup.ArrayLiteralElement
typealias · iOS 13.0+
CollisionGroup.Element
typealias · iOS 13.0+
CollisionGroup.RawValue
typealias · iOS 13.0+
Component
protocol · iOS 13.0+
ComponentEvents
enum · iOS 15.0+
ComponentEvents.DidActivate
struct · iOS 15.0+
ComponentEvents.DidAdd
struct · iOS 15.0+
ComponentEvents.DidChange
struct · iOS 15.0+
ComponentEvents.WillDeactivate
struct · iOS 15.0+
ComponentEvents.WillRemove
struct · iOS 15.0+
ConstantForceEffect
struct · iOS 18.0+
ConstantRadialForceEffect
struct · iOS 18.0+
Contact
struct · iOS 18.0+
CustomMaterial
struct · iOS 15.0+
CustomMaterial.AmbientOcclusion
struct · iOS 15.0+
CustomMaterial.BaseColor
struct · iOS 15.0+
CustomMaterial.Blending
enum · iOS 15.0+
CustomMaterial.Clearcoat
struct · iOS 15.0+
CustomMaterial.Clearcoat.FloatLiteralType
typealias · iOS 15.0+
CustomMaterial.ClearcoatNormal
struct · iOS 18.0+
CustomMaterial.ClearcoatRoughness
struct · iOS 15.0+
CustomMaterial.ClearcoatRoughness.FloatLiteralType
typealias · iOS 15.0+
CustomMaterial.Custom
struct · iOS 15.0+
CustomMaterial.CustomMaterialTexture
struct · iOS 15.0+
CustomMaterial.EmissiveColor
struct · iOS 15.0+
CustomMaterial.FaceCulling
typealias · iOS 15.0+
CustomMaterial.GeometryModifier
struct · iOS 15.0+
CustomMaterial.LightingModel
enum · iOS 15.0+
CustomMaterial.Metallic
struct · iOS 15.0+
CustomMaterial.Metallic.FloatLiteralType
typealias · iOS 15.0+
CustomMaterial.Normal
struct · iOS 15.0+
CustomMaterial.Opacity
struct · iOS 15.0+
CustomMaterial.Opacity.FloatLiteralType
typealias · iOS 15.0+
CustomMaterial.Parameters
typealias · iOS 15.0+
CustomMaterial.Program
class · iOS 18.0+
CustomMaterial.Program.Descriptor
struct · iOS 18.0+
CustomMaterial.ResourceStorage
struct · iOS 18.0+
CustomMaterial.Roughness
struct · iOS 15.0+
CustomMaterial.Roughness.FloatLiteralType
typealias · iOS 15.0+
CustomMaterial.Specular
struct · iOS 15.0+
CustomMaterial.Specular.FloatLiteralType
typealias · iOS 15.0+
CustomMaterial.SurfaceShader
struct · iOS 15.0+
CustomMaterial.Texture
typealias · iOS 15.0+
CustomMaterial.TextureCoordinateTransform
typealias · iOS 15.0+
CustomMaterial.TriangleFillMode
typealias · iOS 18.0+
CustomMaterialError
enum · iOS 15.0+
CustomShaderStage
enum · iOS 18.0+
DiffuseLightProbeGroupComponent
struct · iOS 27.0+
DiffuseLightProbeReceiverComponent
struct · iOS 27.0+
DiffuseProbeResource
class · iOS 27.0+
DirectionalLight
class · iOS 13.0+
DirectionalLightComponent
struct · iOS 13.0+
DirectionalLightComponent.Shadow
struct · iOS 13.0+
DirectionalLightComponent.Shadow.Cascades
struct · iOS 27.0+
DirectionalLightComponent.Shadow.ShadowMapCullMode
typealias · iOS 18.0+
DirectionalLightComponent.Shadow.ShadowProjectionType
enum · iOS 18.0+
DragForceEffect
struct · iOS 18.0+
DynamicLightShadowComponent
struct · iOS 18.0+
EmphasizeAction
struct · iOS 18.0+
EmphasizeAction.EmphasisAnimationStyle
enum · iOS 18.0+
EmphasizeAction.EmphasisAnimationStyle.RawValue
typealias · iOS 18.0+
EmphasizeAction.EmphasisMotionType
enum · iOS 18.0+
EmphasizeAction.EmphasisMotionType.RawValue
typealias · iOS 18.0+
EmphasizeAction.EventParameterType
typealias · iOS 18.0+
Entity
class · iOS 13.0+
Entity.ChildCollection
struct · iOS 13.0+
Entity.ChildCollection.Element
typealias · iOS 13.0+
Entity.ChildCollection.Index
typealias · iOS 13.0+
Entity.ChildCollection.IndexingIterator
struct · iOS 13.0+
Entity.ChildCollection.IndexingIterator.Element
typealias · iOS 13.0+
Entity.ChildCollection.IndexingIterator.Iterator
typealias · iOS 13.0+
Entity.ChildCollection.IndexingIterator.SubSequence
typealias · iOS 13.0+
Entity.ChildCollection.Indices
typealias · iOS 13.0+
Entity.ChildCollection.Iterator
typealias · iOS 13.0+
Entity.ChildCollection.SubSequence
typealias · iOS 13.0+
Entity.ComponentSet
struct · iOS 13.0+
Entity.ComponentSet.Element
typealias · iOS 18.0+
Entity.ComponentSet.Index
struct · iOS 18.0+
Entity.ComponentSet.Indices
struct · iOS 18.0+
Entity.ComponentSet.Indices.Element
typealias · iOS 18.0+
Entity.ComponentSet.Indices.Index
typealias · iOS 18.0+
Entity.ComponentSet.Indices.Indices
typealias · iOS 18.0+
Entity.ComponentSet.Indices.Iterator
typealias · iOS 18.0+
Entity.ComponentSet.Indices.SubSequence
typealias · iOS 18.0+
Entity.ComponentSet.Iterator
struct · iOS 18.0+
Entity.ComponentSet.Iterator.Element
typealias · iOS 18.0+
Entity.ComponentSet.SubSequence
typealias · iOS 18.0+
Entity.ConfigurationCatalog
struct · iOS 18.0+
Entity.ConfigurationCatalog.Configuration
struct · iOS 18.0+
Entity.ConfigurationCatalog.Configuration.ID
typealias · iOS 18.0+
Entity.ConfigurationCatalog.ConfigurationCombination
struct · iOS 18.0+
Entity.ConfigurationCatalog.ConfigurationSet
struct · iOS 18.0+
Entity.ConfigurationCatalog.ConfigurationSet.ID
typealias · iOS 18.0+
Entity.ForwardDirection
enum · iOS 18.0+
Entity.ID
typealias · iOS 13.0+
Entity.Observable
struct · iOS 26.0+
Entity.Observable.Components
struct · iOS 26.0+
Entity.ParameterSet
struct · iOS 15.0+
Entity.WriteOptions
struct · iOS 26.0+
Entity.WriteOptions.ArrayLiteralElement
typealias · iOS 26.0+
Entity.WriteOptions.TextureQuality
struct · iOS 27.0+
EntityAction
protocol · iOS 18.0+
EntityCollection
protocol · iOS 18.0+
EntityGeometricPins
struct · iOS 18.0+
EntityGeometricPins.Element
typealias · iOS 18.0+
EntityGeometricPins.Iterator
struct · iOS 18.0+
EntityGeometricPins.Iterator.Element
typealias · iOS 18.0+
EntityQuery
struct · iOS 15.0+
EnvironmentLightingConfigurationComponent
struct · iOS 18.0+
EnvironmentResource
class · iOS 13.0+
EnvironmentResource.Compression
typealias · iOS 18.0+
EnvironmentResource.CreateOptions
struct · iOS 18.0+
EnvironmentResource.CreateOptions.SamplingQuality
enum · iOS 18.0+
EnvironmentResource.SkyboxMode
struct · iOS 27.0+
Event
protocol · iOS 13.0+
EventSource
protocol · iOS 13.0+
EventSubscription
struct · iOS 18.0+
ForceEffect
struct · iOS 18.0+
ForceEffectBase
protocol · iOS 18.0+
ForceEffectBounds
enum · iOS 18.0+
ForceEffectComponent
struct · iOS 18.0+
ForceEffectComponent.SimulationState
enum · iOS 18.0+
ForceEffectEvent
struct · iOS 18.0+
ForceEffectParameters
struct · iOS 18.0+
ForceEffectProtocol
protocol · iOS 18.0+
ForceMode
enum · iOS 18.0+
FromToByAction
struct · iOS 18.0+
FromToByAction.DecodingErrors
enum · iOS 18.0+
FromToByAction.EventParameterType
typealias · iOS 18.0+
FromToByAction.TransformMode
enum · iOS 18.0+
FromToByAnimation
struct · iOS 15.0+
GeometricPin
struct · iOS 18.0+
GeometricPinsComponent
struct · iOS 18.0+
GestureComponent
struct · iOS 26.0+
GroundingShadowComponent
struct · iOS 18.0+
GroundingShadowComponent.FadeBehaviorNearPhysicalObjects
enum · iOS 18.0+
HairLightingModel
struct · iOS 27.0+
HasAnchoring
protocol · iOS 13.0+
HasBodyTracking
protocol · iOS 13.0+
HasCollision
protocol · iOS 13.0+
HasDirectionalLight
protocol · iOS 13.0+
HasHierarchy
protocol · iOS 13.0+
HasModel
protocol · iOS 13.0+
HasPerspectiveCamera
protocol · iOS 13.0+
HasPhysics
protocol · iOS 13.0+
HasPhysicsBody
protocol · iOS 13.0+
HasPhysicsMotion
protocol · iOS 13.0+
HasPointLight
protocol · iOS 13.0+
HasSceneUnderstanding
protocol · iOS 13.4+
HasSpotLight
protocol · iOS 13.0+
HasSynchronization
protocol · iOS 13.0+
HasTransform
protocol · iOS 13.0+
HoverEffectComponent
struct · iOS 18.0+
HoverEffectComponent.GroupID
struct · iOS 26.0+
HoverEffectComponent.HighlightHoverEffectStyle
struct · iOS 18.0+
HoverEffectComponent.HoverEffect
struct · iOS 18.0+
HoverEffectComponent.OpacityFunction
enum · iOS 18.0+
HoverEffectComponent.ShaderHoverEffectInputs
struct · iOS 18.0+
HoverEffectComponent.SpotlightHoverEffectStyle
struct · iOS 18.0+
IKComponent
struct · iOS 18.0+
IKComponent.Constraint
class · iOS 18.0+
IKComponent.Constraint.DemandOptions
struct · iOS 18.0+
IKComponent.Constraint.DemandOptions.ArrayLiteralElement
typealias · iOS 18.0+
IKComponent.Constraint.DemandOptions.Element
typealias · iOS 18.0+
IKComponent.Constraint.DemandOptions.RawValue
typealias · iOS 18.0+
IKComponent.Constraint.ID
typealias · iOS 18.0+
IKComponent.ConstraintCollection
struct · iOS 18.0+
IKComponent.ConstraintCollection.Element
typealias · iOS 18.0+
IKComponent.ConstraintCollection.Index
typealias · iOS 18.0+
IKComponent.ConstraintCollection.Indices
typealias · iOS 18.0+
IKComponent.ConstraintCollection.Iterator
struct · iOS 18.0+
IKComponent.ConstraintCollection.Iterator.Element
typealias · iOS 18.0+
IKComponent.ConstraintCollection.SubSequence
typealias · iOS 18.0+
IKComponent.Joint
class · iOS 18.0+
IKComponent.Joint.ID
typealias · iOS 18.0+
IKComponent.JointCollection
struct · iOS 18.0+
IKComponent.JointCollection.Element
typealias · iOS 18.0+
IKComponent.JointCollection.Index
typealias · iOS 18.0+
IKComponent.JointCollection.Indices
typealias · iOS 18.0+
IKComponent.JointCollection.Iterator
struct · iOS 18.0+
IKComponent.JointCollection.Iterator.Element
typealias · iOS 18.0+
IKComponent.JointCollection.SubSequence
typealias · iOS 18.0+
IKComponent.Solver
class · iOS 18.0+
IKComponent.Solver.ID
struct · iOS 18.0+
IKComponent.SolverCollection
struct · iOS 18.0+
IKComponent.SolverCollection.Element
typealias · iOS 18.0+
IKComponent.SolverCollection.Index
typealias · iOS 18.0+
IKComponent.SolverCollection.Indices
typealias · iOS 18.0+
IKComponent.SolverCollection.Iterator
struct · iOS 18.0+
IKComponent.SolverCollection.Iterator.Element
typealias · iOS 18.0+
IKComponent.SolverCollection.SubSequence
typealias · iOS 18.0+
IKResource
class · iOS 18.0+
IKRig
struct · iOS 18.0+
IKRig.Constraint
struct · iOS 18.0+
IKRig.Constraint.ID
struct · iOS 18.0+
IKRig.Constraint.IKOrientationDemand
struct · iOS 18.0+
IKRig.Constraint.IKOrientationDemand.Mode
enum · iOS 18.0+
IKRig.Constraint.IKPositionDemand
struct · iOS 18.0+
IKRig.Constraint.IKPositionDemand.Mode
enum · iOS 18.0+
IKRig.ConstraintsCollection
struct · iOS 18.0+
IKRig.ConstraintsCollection.ArrayLiteralElement
typealias · iOS 18.0+
IKRig.ConstraintsCollection.Element
typealias · iOS 18.0+
IKRig.ConstraintsCollection.Index
typealias · iOS 18.0+
IKRig.ConstraintsCollection.Indices
typealias · iOS 18.0+
IKRig.ConstraintsCollection.Iterator
struct · iOS 18.0+
IKRig.ConstraintsCollection.Iterator.Element
typealias · iOS 18.0+
IKRig.ConstraintsCollection.SubSequence
typealias · iOS 18.0+
IKRig.Joint
struct · iOS 18.0+
IKRig.Joint.ID
struct · iOS 18.0+
IKRig.Joint.LimitsDefinition
struct · iOS 18.0+
IKRig.Joint.LimitsDefinition.Axis
enum · iOS 18.0+
IKRig.JointCollection
struct · iOS 18.0+
IKRig.JointCollection.Element
typealias · iOS 18.0+
IKRig.JointCollection.Index
typealias · iOS 18.0+
IKRig.JointCollection.Indices
typealias · iOS 18.0+
IKRig.JointCollection.Iterator
struct · iOS 18.0+
IKRig.JointCollection.Iterator.Element
typealias · iOS 18.0+
IKRig.JointCollection.SubSequence
typealias · iOS 18.0+
IKSolverDefinition
struct · iOS 18.0+
IKSolverDefinition.ID
typealias · iOS 18.0+
ImageBasedLightComponent
struct · iOS 18.0+
ImageBasedLightComponent.Source
enum · iOS 18.0+
ImageBasedLightReceiverComponent
struct · iOS 18.0+
ImpulseAction
struct · iOS 18.0+
ImpulseAction.EventParameterType
typealias · iOS 18.0+
InputTargetComponent
struct · iOS 18.0+
InputTargetComponent.InputType
struct · iOS 18.0+
InputTargetComponent.InputType.ArrayLiteralElement
typealias · iOS 18.0+
InputTargetComponent.InputType.Element
typealias · iOS 18.0+
InputTargetComponent.InputType.RawValue
typealias · iOS 18.0+
InternalBindPath
struct · iOS 15.0+
JointTransforms
struct · iOS 15.0+
JointTransforms.ArrayLiteralElement
typealias · iOS 15.0+
JointTransforms.Element
typealias · iOS 15.0+
JointTransforms.Index
typealias · iOS 15.0+
JointTransforms.Indices
typealias · iOS 15.0+
JointTransforms.Iterator
typealias · iOS 15.0+
JointTransforms.SubSequence
typealias · iOS 15.0+
LensDistortionData
struct · iOS 26.0+
LevelOfDetailComponent
struct · iOS 27.0+
LevelOfDetailComponent.DetailLevel
typealias · iOS 27.0+
LevelOfDetailComponent.LevelSelection
struct · iOS 27.0+
LevelOfDetailComponent.SelectionStrategy
struct · iOS 27.0+
LevelOfDetailComponent.SelectionStrategy.ResolutionMetric
struct · iOS 27.0+
LevelOfDetailComponent.SelectionStrategy.ResolutionMetric.DirectionalSwitchingResolutions
struct · iOS 27.0+
LightingModel
enum · iOS 27.0+
LightmapComponent
struct · iOS 27.0+
LightmapComponent.EntityIndex
typealias · iOS 27.0+
LightmapComponent.FinalShadedColorBakeMaterial
struct · iOS 27.0+
LightmapComponent.FinalShadedColorBakeMaterial.Parameters
typealias · iOS 15.0+
LightmapResource
class · iOS 27.0+
LightmapResource.AmbientOcclusionBakeDescriptor
struct · iOS 27.0+
LightmapResource.AtlasReference
struct · iOS 27.0+
LightmapResource.BakeDescriptor
enum · iOS 27.0+
LightmapResource.BakeType
enum · iOS 27.0+
LightmapResource.EntityLightmapDescriptor
struct · iOS 27.0+
LightmapResource.FinalShadedColorBakeDescriptor
struct · iOS 27.0+
LightmapResource.IndirectDiffuseIrradianceBakeDescriptor
struct · iOS 27.0+
LightmapResource.MeshPartLightmapDescriptor
struct · iOS 27.0+
LitLightingModel
struct · iOS 27.0+
LitLightingModel.DiffuseModel
enum · iOS 27.0+
LitLightingModel.SpecularModel
enum · iOS 27.0+
LoadRequest
class · iOS 13.0+ · Deprecated in iOS 18.0
LoadRequest.Failure
typealias · iOS 13.0+ · Deprecated in iOS 18.0
LowLevelBuffer
class · iOS 26.0+
LowLevelBuffer.Descriptor
struct · iOS 26.0+
LowLevelDeviceResource
class · iOS 27.0+
LowLevelInstanceData
class · iOS 26.0+
LowLevelMesh
class · iOS 18.0+
LowLevelMesh.Attribute
struct · iOS 18.0+
LowLevelMesh.Descriptor
struct · iOS 18.0+
LowLevelMesh.Layout
struct · iOS 18.0+
LowLevelMesh.Part
struct · iOS 18.0+
LowLevelMesh.PartsCollection
struct · iOS 18.0+
LowLevelMesh.PartsCollection.Element
typealias · iOS 18.0+
LowLevelMesh.PartsCollection.Index
typealias · iOS 18.0+
LowLevelMesh.PartsCollection.Indices
typealias · iOS 18.0+
LowLevelMesh.PartsCollection.Iterator
typealias · iOS 18.0+
LowLevelMesh.PartsCollection.SubSequence
typealias · iOS 18.0+
LowLevelMesh.VertexSemantic
enum · iOS 18.0+
LowLevelTexture
class · iOS 18.0+
LowLevelTexture.Descriptor
struct · iOS 18.0+
Material
protocol · iOS 13.0+
Material.Parameters
typealias · iOS 15.0+
MaterialFunction
protocol · iOS 15.0+
MaterialParameters
struct · iOS 15.0+
MaterialParameters.Handle
struct · iOS 18.0+
MaterialParameters.Texture
struct · iOS 15.0+
MaterialParameters.Texture.Sampler
struct · iOS 15.0+
MaterialParameters.Value
enum · iOS 18.0+
MaterialParameterTypes
struct · iOS 15.0+
MaterialParameterTypes.BlendMode
enum · iOS 18.0+
MaterialParameterTypes.FaceCulling
enum · iOS 15.0+
MaterialParameterTypes.TextureCoordinateTransform
struct · iOS 15.0+
MaterialParameterTypes.TriangleFillMode
enum · iOS 18.0+
MaterialScalarParameter
enum · iOS 13.0+
MaterialScalarParameter.FloatLiteralType
typealias · iOS 13.0+
MaterialScalarParameter.IntegerLiteralType
typealias · iOS 13.0+
MeshBuffer
struct · iOS 15.0+
MeshBuffer.Element
typealias · iOS 15.0+
MeshBuffer.Iterator
struct · iOS 15.0+
MeshBufferContainer
protocol · iOS 15.0+
MeshBuffers
enum · iOS 15.0+
MeshBuffers.BlendShapeOffsets
typealias · iOS 18.0+
MeshBuffers.ElementType
enum · iOS 15.0+
MeshBuffers.Identifier
struct · iOS 15.0+
MeshBuffers.JointInfluences
typealias · iOS 18.0+
MeshBuffers.Normals
typealias · iOS 15.0+
MeshBuffers.Positions
typealias · iOS 15.0+
MeshBuffers.Rate
enum · iOS 15.0+
MeshBuffers.Semantic
struct · iOS 15.0+
MeshBuffers.Semantic.ID
typealias · iOS 15.0+
MeshBuffers.Tangents
typealias · iOS 15.0+
MeshBuffers.TextureCoordinates
typealias · iOS 15.0+
MeshBuffers.TriangleIndices
typealias · iOS 15.0+
MeshBuffers.UVs
typealias · iOS 27.0+
MeshBufferSemantic
protocol · iOS 15.0+
MeshDeformationStack
struct · iOS 27.0+
MeshDeformCPUBufferInput
typealias · iOS 27.0+
MeshDeformCPUBufferOutput
typealias · iOS 27.0+
MeshDeformer
protocol · iOS 27.0+
MeshDeformerComponent
struct · iOS 27.0+
MeshDeformerExecutionMode
enum · iOS 27.0+
MeshDeformerOptions
struct · iOS 27.0+
MeshDeformerOptions.Cadence
enum · iOS 27.0+
MeshDeformerVertexOptions
struct · iOS 27.0+
MeshDeformerVertexOptions.ArrayLiteralElement
typealias · iOS 27.0+
MeshDeformerVertexOptions.Element
typealias · iOS 27.0+
MeshDeformerVertexOptions.OptionStorage
typealias · iOS 27.0+
MeshDeformerVertexOptions.RawValue
typealias · iOS 27.0+
MeshDeformGPUBufferInput
typealias · iOS 27.0+
MeshDeformGPUBufferOutput
typealias · iOS 27.0+
MeshDeformParameter
struct · iOS 27.0+
MeshDeformParameter.VertexBuffers
struct · iOS 27.0+
MeshDeformParameter.VertexBuffers.Data
struct · iOS 27.0+
MeshDeformParameterCPU
typealias · iOS 27.0+
MeshDeformParameterGPU
typealias · iOS 27.0+
MeshDeformParametersCPU
typealias · iOS 27.0+
MeshDeformParametersGPU
typealias · iOS 27.0+
MeshDescriptor
struct · iOS 15.0+
MeshDescriptor.Materials
enum · iOS 15.0+
MeshDescriptor.Primitives
enum · iOS 15.0+
MeshInstanceCollection
struct · iOS 15.0+
MeshInstanceCollection.ArrayLiteralElement
typealias · iOS 15.0+
MeshInstanceCollection.Element
typealias · iOS 15.0+
MeshInstanceCollection.Index
typealias · iOS 18.0+
MeshInstanceCollection.Indices
typealias · iOS 18.0+
MeshInstanceCollection.Iterator
struct · iOS 15.0+
MeshInstanceCollection.Iterator.Element
typealias · iOS 15.0+
MeshInstanceCollection.SubSequence
typealias · iOS 18.0+
MeshInstancesComponent
struct · iOS 26.0+
MeshInstancesComponent.Part
struct · iOS 26.0+
MeshJointInfluence
struct · iOS 18.0+
MeshModelCollection
struct · iOS 15.0+
MeshModelCollection.ArrayLiteralElement
typealias · iOS 15.0+
MeshModelCollection.Element
typealias · iOS 15.0+
MeshModelCollection.Index
typealias · iOS 18.0+
MeshModelCollection.Indices
typealias · iOS 18.0+
MeshModelCollection.Iterator
struct · iOS 15.0+
MeshModelCollection.Iterator.Element
typealias · iOS 15.0+
MeshModelCollection.SubSequence
typealias · iOS 18.0+
MeshPartCollection
struct · iOS 15.0+
MeshPartCollection.ArrayLiteralElement
typealias · iOS 15.0+
MeshPartCollection.Element
typealias · iOS 15.0+
MeshPartCollection.Index
typealias · iOS 18.0+
MeshPartCollection.Indices
typealias · iOS 18.0+
MeshPartCollection.Iterator
struct · iOS 15.0+
MeshPartCollection.Iterator.Element
typealias · iOS 15.0+
MeshPartCollection.SubSequence
typealias · iOS 18.0+
MeshResource
class · iOS 13.0+
MeshResource.Contents
struct · iOS 15.0+
MeshResource.GenerateTextOptions
struct · iOS 18.0+
MeshResource.Instance
struct · iOS 15.0+
MeshResource.Instance.ID
typealias · iOS 15.0+
MeshResource.JointInfluences
struct · iOS 18.0+
MeshResource.Model
struct · iOS 15.0+
MeshResource.Model.ID
typealias · iOS 15.0+
MeshResource.Part
struct · iOS 15.0+
MeshResource.Part.ID
typealias · iOS 15.0+
MeshResource.ShapeExtrusionOptions
struct · iOS 18.0+
MeshResource.ShapeExtrusionOptions.ChamferMode
enum · iOS 18.0+
MeshResource.ShapeExtrusionOptions.CurveStrokeResolution
enum · iOS 18.0+
MeshResource.ShapeExtrusionOptions.ExtrusionMethod
enum · iOS 18.0+
MeshResource.ShapeExtrusionOptions.MaterialAssignment
struct · iOS 18.0+
MeshResource.Skeleton
struct · iOS 18.0+
MeshResource.Skeleton.ID
typealias · iOS 18.0+
MeshResource.Skeleton.Joint
struct · iOS 18.0+
MeshScope
struct · iOS 27.0+
MeshSkeletonCollection
struct · iOS 18.0+
MeshSkeletonCollection.ArrayLiteralElement
typealias · iOS 18.0+
MeshSkeletonCollection.Element
typealias · iOS 18.0+
MeshSkeletonCollection.Index
typealias · iOS 18.0+
MeshSkeletonCollection.Indices
typealias · iOS 18.0+
MeshSkeletonCollection.Iterator
struct · iOS 18.0+
MeshSkeletonCollection.Iterator.Element
typealias · iOS 18.0+
MeshSkeletonCollection.SubSequence
typealias · iOS 18.0+
ModelComponent
struct · iOS 13.0+
ModelDebugOptionsComponent
struct · iOS 14.0+
ModelDebugOptionsComponent.VisualizationMode
enum · iOS 14.0+
ModelDebugOptionsComponent.VisualizationMode.RawValue
typealias · iOS 14.0+
ModelEntity
class · iOS 13.0+
ModelSortGroup
struct · iOS 18.0+
ModelSortGroup.DepthPass
enum · iOS 18.0+
ModelSortGroup.PlanarUIPlacement
enum · iOS 18.0+
ModelSortGroupComponent
struct · iOS 18.0+
NavigationComponent
struct · iOS 27.0+
NavigationComponent.Filter
struct · iOS 27.0+
NavigationController
struct · iOS 27.0+
NavigationController.PathfindStatus
enum · iOS 27.0+
NavigationMeshComponent
struct · iOS 27.0+
NavigationMeshResource
class · iOS 27.0+
NavigationMeshResource.Area
struct · iOS 27.0+
NavigationMeshResource.Area.RawValue
typealias · iOS 27.0+
NavigationMeshResource.Configuration
struct · iOS 27.0+
NavigationMeshResource.Configuration.PartitionMethod
enum · iOS 27.0+
NavigationMeshResource.Flag
struct · iOS 27.0+
NavigationMeshResource.Flag.RawValue
typealias · iOS 27.0+
NavigationMeshResource.FlagGroup
struct · iOS 27.0+
NavigationMeshResource.FlagGroup.ArrayLiteralElement
typealias · iOS 27.0+
NavigationMeshResource.FlagGroup.Element
typealias · iOS 27.0+
NavigationMeshResource.FlagGroup.RawValue
typealias · iOS 27.0+
NavigationMeshResource.HeightData
struct · iOS 27.0+
NavigationMeshResource.Layer
struct · iOS 27.0+
NavigationMeshResource.Layer.RawValue
typealias · iOS 27.0+
NavigationMeshResource.OffMeshConnection
struct · iOS 27.0+
NavigationMeshResource.PathNode
struct · iOS 27.0+
NavigationMeshResource.PathNode.Category
enum · iOS 27.0+
NetworkCompatibilityToken
class · iOS 13.4+
NetworkCompatibilityToken.Compatibility
enum · iOS 13.4+
OcclusionCullingComponent
struct · iOS 27.0+
OcclusionMaterial
struct · iOS 13.0+
OcclusionMaterial.FaceCulling
typealias · iOS 18.0+
OcclusionMaterial.Parameters
typealias · iOS 15.0+
OpacityComponent
struct · iOS 18.0+
OrbitAnimation
struct · iOS 15.0+
OrbitEntityAction
struct · iOS 18.0+
OrbitEntityAction.EventParameterType
typealias · iOS 18.0+
OrientedBoundingBox
struct · iOS 17.0+
OrthographicCameraComponent
struct · iOS 18.0+
ParameterSet
struct · iOS 15.0+
ParticleEmitterComponent
struct · iOS 18.0+
ParticleEmitterComponent.BirthDirection
enum · iOS 18.0+
ParticleEmitterComponent.BirthLocation
enum · iOS 18.0+
ParticleEmitterComponent.EmitterShape
enum · iOS 18.0+
ParticleEmitterComponent.ParticleEmitter
struct · iOS 18.0+
ParticleEmitterComponent.ParticleEmitter.BillboardMode
enum · iOS 18.0+
ParticleEmitterComponent.ParticleEmitter.BlendMode
enum · iOS 18.0+
ParticleEmitterComponent.ParticleEmitter.ImageSequence
struct · iOS 18.0+
ParticleEmitterComponent.ParticleEmitter.ImageSequence.AnimationRepeatMode
enum · iOS 18.0+
ParticleEmitterComponent.ParticleEmitter.OpacityCurve
enum · iOS 18.0+
ParticleEmitterComponent.ParticleEmitter.SortOrder
enum · iOS 18.0+
ParticleEmitterComponent.SimulationSpace
enum · iOS 18.0+
ParticleEmitterComponent.SimulationState
enum · iOS 18.0+
ParticleEmitterComponent.SpawnOccasion
enum · iOS 18.0+
PerspectiveCamera
class · iOS 13.0+
PerspectiveCameraComponent
struct · iOS 13.0+
PhotogrammetrySample
struct · iOS 17.0+
PhotogrammetrySample.Camera
struct · iOS 18.0+
PhotogrammetrySample.ID
typealias · iOS 17.0+
PhotogrammetrySession
class · iOS 17.0+
PhotogrammetrySession.Configuration
struct · iOS 17.0+
PhotogrammetrySession.Configuration.FeatureSensitivity
enum · iOS 17.0+
PhotogrammetrySession.Configuration.SampleOrdering
enum · iOS 17.0+
PhotogrammetrySession.Error
enum · iOS 17.0+
PhotogrammetrySession.ID
typealias · iOS 17.0+
PhotogrammetrySession.Limits
struct · iOS 17.0+
PhotogrammetrySession.Output
enum · iOS 17.0+
PhotogrammetrySession.Output.ProcessingStage
enum · iOS 17.0+
PhotogrammetrySession.Output.ProgressInfo
struct · iOS 17.0+
PhotogrammetrySession.Outputs
struct · iOS 17.0+
PhotogrammetrySession.Outputs.AsyncIterator
typealias · iOS 17.0+
PhotogrammetrySession.Outputs.Element
typealias · iOS 17.0+
PhotogrammetrySession.Outputs.Iterator
struct · iOS 17.0+
PhotogrammetrySession.Outputs.Iterator.Element
typealias · iOS 17.0+
PhotogrammetrySession.PointCloud
struct · iOS 17.0+
PhotogrammetrySession.PointCloud.Point
struct · iOS 17.0+
PhotogrammetrySession.Pose
struct · iOS 17.0+
PhotogrammetrySession.Poses
struct · iOS 17.0+
PhotogrammetrySession.Request
enum · iOS 17.0+
PhotogrammetrySession.Request.Detail
enum · iOS 17.0+
PhotogrammetrySession.Request.Detail.RawValue
typealias · iOS 17.0+
PhotogrammetrySession.Request.Geometry
struct · iOS 17.0+
PhotogrammetrySession.Result
enum · iOS 17.0+
PhysicallyBasedDecalComponent
struct · iOS 27.0+
PhysicallyBasedMaterial
struct · iOS 15.0+
PhysicallyBasedMaterial.AmbientOcclusion
struct · iOS 15.0+
PhysicallyBasedMaterial.AnisotropyAngle
struct · iOS 15.0+
PhysicallyBasedMaterial.AnisotropyAngle.FloatLiteralType
typealias · iOS 15.0+
PhysicallyBasedMaterial.AnisotropyLevel
struct · iOS 15.0+
PhysicallyBasedMaterial.AnisotropyLevel.FloatLiteralType
typealias · iOS 15.0+
PhysicallyBasedMaterial.BaseColor
struct · iOS 15.0+
PhysicallyBasedMaterial.BentNormal
struct · iOS 27.0+
PhysicallyBasedMaterial.Blending
enum · iOS 15.0+
PhysicallyBasedMaterial.Clearcoat
struct · iOS 15.0+
PhysicallyBasedMaterial.Clearcoat.FloatLiteralType
typealias · iOS 15.0+
PhysicallyBasedMaterial.ClearcoatNormal
struct · iOS 18.0+
PhysicallyBasedMaterial.ClearcoatRoughness
struct · iOS 15.0+
PhysicallyBasedMaterial.ClearcoatRoughness.FloatLiteralType
typealias · iOS 15.0+
PhysicallyBasedMaterial.EmissiveColor
struct · iOS 15.0+
PhysicallyBasedMaterial.FaceCulling
typealias · iOS 15.0+
PhysicallyBasedMaterial.Metallic
struct · iOS 15.0+
PhysicallyBasedMaterial.Metallic.FloatLiteralType
typealias · iOS 15.0+
PhysicallyBasedMaterial.Normal
struct · iOS 15.0+
PhysicallyBasedMaterial.Opacity
struct · iOS 15.0+
PhysicallyBasedMaterial.Opacity.FloatLiteralType
typealias · iOS 15.0+
PhysicallyBasedMaterial.Parameters
typealias · iOS 15.0+
PhysicallyBasedMaterial.Program
class · iOS 18.0+
PhysicallyBasedMaterial.Program.Descriptor
struct · iOS 18.0+
PhysicallyBasedMaterial.Roughness
struct · iOS 15.0+
PhysicallyBasedMaterial.Roughness.FloatLiteralType
typealias · iOS 15.0+
PhysicallyBasedMaterial.SheenColor
struct · iOS 15.0+
PhysicallyBasedMaterial.Specular
struct · iOS 15.0+
PhysicallyBasedMaterial.Specular.FloatLiteralType
typealias · iOS 15.0+
PhysicallyBasedMaterial.SubsurfaceColor
struct · iOS 27.0+
PhysicallyBasedMaterial.SubsurfaceRadius
struct · iOS 27.0+
PhysicallyBasedMaterial.SubsurfaceRadius.FloatLiteralType
typealias · iOS 27.0+
PhysicallyBasedMaterial.SubsurfaceRadiusScale
struct · iOS 27.0+
PhysicallyBasedMaterial.SubsurfaceScatterAnisotropy
struct · iOS 27.0+
PhysicallyBasedMaterial.SubsurfaceScatterAnisotropy.FloatLiteralType
typealias · iOS 27.0+
PhysicallyBasedMaterial.SubsurfaceWeight
struct · iOS 27.0+
PhysicallyBasedMaterial.SubsurfaceWeight.FloatLiteralType
typealias · iOS 27.0+
PhysicallyBasedMaterial.Texture
typealias · iOS 15.0+
PhysicallyBasedMaterial.TextureCoordinateTransform
typealias · iOS 15.0+
PhysicallyBasedMaterial.TriangleFillMode
typealias · iOS 18.0+
PhysicsBodyComponent
struct · iOS 13.0+
PhysicsBodyMode
enum · iOS 13.0+
PhysicsBodyParameterTypes
struct · iOS 18.0+
PhysicsBodyParameterTypes.ArrayLiteralElement
typealias · iOS 18.0+
PhysicsBodyParameterTypes.Element
typealias · iOS 18.0+
PhysicsBodyParameterTypes.RawValue
typealias · iOS 18.0+
PhysicsCustomJoint
struct · iOS 18.0+
PhysicsCustomJoint.MotionLimit
enum · iOS 18.0+
PhysicsDistanceJoint
struct · iOS 18.0+
PhysicsFixedJoint
struct · iOS 18.0+
PhysicsJoint
protocol · iOS 18.0+
PhysicsJoints
struct · iOS 18.0+
PhysicsJoints.ArrayLiteralElement
typealias · iOS 18.0+
PhysicsJoints.Element
typealias · iOS 18.0+
PhysicsJoints.Index
typealias · iOS 18.0+
PhysicsJoints.Indices
typealias · iOS 18.0+
PhysicsJoints.Iterator
typealias · iOS 18.0+
PhysicsJoints.SubSequence
typealias · iOS 18.0+
PhysicsJointsComponent
struct · iOS 18.0+
PhysicsMassProperties
struct · iOS 13.0+
PhysicsMaterialResource
class · iOS 13.0+
PhysicsMotionComponent
struct · iOS 13.0+
PhysicsPrismaticJoint
struct · iOS 18.0+
PhysicsRevoluteJoint
struct · iOS 18.0+
PhysicsSimulationComponent
struct · iOS 18.0+
PhysicsSimulationComponent.CollisionOptions
struct · iOS 18.0+
PhysicsSimulationComponent.CollisionOptions.ArrayLiteralElement
typealias · iOS 18.0+
PhysicsSimulationComponent.CollisionOptions.Element
typealias · iOS 18.0+
PhysicsSimulationComponent.CollisionOptions.RawValue
typealias · iOS 18.0+
PhysicsSimulationComponent.SolverIterations
struct · iOS 18.0+
PhysicsSimulationEvents
enum · iOS 18.0+
PhysicsSimulationEvents.DidSimulate
struct · iOS 18.0+
PhysicsSimulationEvents.WillSimulate
struct · iOS 18.0+
PhysicsSphericalJoint
struct · iOS 18.0+
PixelCastHit
struct · iOS 18.0+
PlayAnimationAction
struct · iOS 18.0+
PlayAnimationAction.EventParameterType
typealias · iOS 18.0+
PlayAudioAction
struct · iOS 18.0+
PlayAudioAction.EventParameterType
typealias · iOS 18.0+
PointLight
class · iOS 13.0+
PointLightComponent
struct · iOS 13.0+
PortalComponent
struct · iOS 18.0+
PortalComponent.BoundaryMode
enum · iOS 27.0+
PortalComponent.BoundaryStyle
struct · iOS 27.0+
PortalComponent.ClippingMode
enum · iOS 18.0+
PortalComponent.ClippingPlane
struct · iOS 18.0+
PortalComponent.CrossingMode
enum · iOS 18.0+
PortalComponent.Options
struct · iOS 18.0+
PortalComponent.Options.ArrayLiteralElement
typealias · iOS 18.0+
PortalComponent.Options.Element
typealias · iOS 18.0+
PortalComponent.Options.RawValue
typealias · iOS 18.0+
PortalComponent.Plane
struct · iOS 18.0+
PortalComponent.Portal
struct · iOS 27.0+
PortalComponent.SurfaceStyle
struct · iOS 27.0+
PortalComponent.Volume
struct · iOS 27.0+
PortalCrossingComponent
struct · iOS 18.0+
PortalMaterial
struct · iOS 18.0+
PortalMaterial.FaceCulling
typealias · iOS 18.0+
PortalMaterial.Parameters
typealias · iOS 15.0+
PortalMaterial.Program
struct · iOS 27.0+
PortalMaterial.Program.Descriptor
struct · iOS 27.0+
PortalMaterial.TriangleFillMode
typealias · iOS 18.0+
PostProcessEffect
protocol · iOS 26.0+
PostProcessEffectContext
struct · iOS 26.0+
ProjectiveTransformCameraComponent
struct · iOS 18.0+
QueryPredicate
struct · iOS 15.0+
QueryResult
struct · iOS 15.0+
QueryResult.Iterator
struct · iOS 15.0+
RadialForceEffect
struct · iOS 18.0+
RealityCoordinateSpace
protocol · iOS 18.0+
RealityRenderer
class · iOS 18.0+
RealityRenderer.CameraOutput
struct · iOS 18.0+
RealityRenderer.CameraOutput.Descriptor
struct · iOS 18.0+
RealityRenderer.CameraOutput.RelativeViewport
struct · iOS 18.0+
RealityRenderer.CameraSettings
struct · iOS 18.0+
RealityRenderer.CameraSettings.ColorBackground
struct · iOS 18.0+
RealityRenderer.EntityCollection
struct · iOS 18.0+
RealityRenderer.EntityCollection.Element
typealias · iOS 18.0+
RealityRenderer.EntityCollection.Index
typealias · iOS 18.0+
RealityRenderer.EntityCollection.Indices
typealias · iOS 18.0+
RealityRenderer.EntityCollection.Iterator
typealias · iOS 18.0+
RealityRenderer.EntityCollection.SubSequence
typealias · iOS 18.0+
RealityRenderer.ImageBasedLight
struct · iOS 18.0+
RealityRenderer.MetalEventAction
struct · iOS 18.0+
ReferenceComponent
struct · iOS 18.0+
ReferenceComponent.LoadingPolicy
enum · iOS 18.0+
ReferenceComponent.ReferenceState
enum · iOS 18.0+
RenderLayer
struct · iOS 27.0+
RenderLayer.Set
struct · iOS 27.0+
RenderLayer.Set.ArrayLiteralElement
typealias · iOS 27.0+
RenderLayer.Set.Element
typealias · iOS 27.0+
RenderLayer.Set.Iterator
struct · iOS 27.0+
RenderLayer.Set.Iterator.Element
typealias · iOS 27.0+
RenderLayerComponent
struct · iOS 27.0+
RenormalizingDeformer
struct · iOS 27.0+
Resource
protocol · iOS 13.0+
RetargetingConfiguration
class · iOS 27.0+
Reverb
struct · iOS 18.0+
Reverb.Preset
struct · iOS 18.0+
ReverbComponent
struct · iOS 18.0+
ReverbMeshResource
class · iOS 27.0+
SampledAnimation
struct · iOS 15.0+
SampledAnimation.SkeletalAnimationOperation
struct · iOS 27.0+
SampledAnimation.SkeletalAnimationOperation.RootMotionOptions
struct · iOS 27.0+
SampledAnimation.SkeletalAnimationOperation.RootMotionOptions.ArrayLiteralElement
typealias · iOS 27.0+
SampledAnimation.SkeletalAnimationOperation.RootMotionOptions.Element
typealias · iOS 27.0+
SampledAnimation.SkeletalAnimationOperation.RootMotionOptions.RawValue
typealias · iOS 27.0+
Scene
class · iOS 13.0+
Scene.AnchorCollection
struct · iOS 13.0+
Scene.AnchorCollection.Element
typealias · iOS 13.0+
Scene.AnchorCollection.Index
typealias · iOS 13.0+
Scene.AnchorCollection.Indices
typealias · iOS 13.0+
Scene.AnchorCollection.Iterator
typealias · iOS 13.0+
Scene.AnchorCollection.SubSequence
typealias · iOS 13.0+
Scene.ID
typealias · iOS 13.0+
Scene.Publisher
struct · iOS 13.0+
Scene.Publisher.Failure
typealias · iOS 13.0+
Scene.Publisher.Output
typealias · iOS 13.0+
SceneEvents
enum · iOS 13.0+
SceneEvents.AnchoredStateChanged
struct · iOS 13.0+
SceneEvents.DidActivateEntity
struct · iOS 15.0+
SceneEvents.DidAddEntity
struct · iOS 15.0+
SceneEvents.DidReparentEntity
struct · iOS 15.0+
SceneEvents.Update
struct · iOS 13.0+
SceneEvents.WillDeactivateEntity
struct · iOS 15.0+
SceneEvents.WillRemoveEntity
struct · iOS 15.0+
SceneRealityCoordinateSpace
struct · iOS 18.0+
SceneUnderstandingComponent
struct · iOS 13.4+
SceneUnderstandingComponent.EntityType
enum · iOS 15.0+
SceneUnderstandingComponent.Origin
enum · iOS 18.0+
SceneUpdateContext
struct · iOS 15.0+
SetEntityEnabledAction
struct · iOS 18.0+
SetEntityEnabledAction.EventParameterType
typealias · iOS 18.0+
ShaderGraphMaterial
struct · iOS 18.0+
ShaderGraphMaterial.Error
enum · iOS 18.0+
ShaderGraphMaterial.FaceCulling
typealias · iOS 18.0+
ShaderGraphMaterial.LoadError
enum · iOS 18.0+
ShaderGraphMaterial.Parameters
typealias · iOS 15.0+
ShaderGraphMaterial.Program
struct · iOS 27.0+
ShaderGraphMaterial.Program.Descriptor
struct · iOS 27.0+
ShaderGraphMaterial.TriangleFillMode
typealias · iOS 18.0+
ShapeResource
class · iOS 13.0+
ShapeResourceError
enum · iOS 18.0+
SimpleMaterial
struct · iOS 13.0+
SimpleMaterial.BaseColor
typealias · iOS 15.0+
SimpleMaterial.FaceCulling
typealias · iOS 18.0+
SimpleMaterial.Parameters
typealias · iOS 15.0+
SimpleMaterial.Texture
typealias · iOS 15.0+
SimpleMaterial.TriangleFillMode
typealias · iOS 18.0+
SkeletalPose
struct · iOS 18.0+
SkeletalPose.ID
typealias · iOS 18.0+
SkeletalPosesComponent
struct · iOS 18.0+
SkeletalPoseSet
struct · iOS 18.0+
SkeletalPoseSet.Element
typealias · iOS 18.0+
SkeletalPoseSet.Index
typealias · iOS 18.0+
SkeletalPoseSet.Indices
typealias · iOS 18.0+
SkeletalPoseSet.Iterator
struct · iOS 18.0+
SkeletalPoseSet.Iterator.Element
typealias · iOS 18.0+
SkeletalPoseSet.SubSequence
typealias · iOS 18.0+
SkeletonResource
class · iOS 27.0+
SkeletonResource.AnimationEvaluation
struct · iOS 27.0+
SkeletonResource.BlendMask
struct · iOS 27.0+
SkeletonResource.BlendMask.ID
typealias · iOS 27.0+
SkeletonResource.Joint
struct · iOS 27.0+
SkeletonResource.Joint.ID
typealias · iOS 27.0+
SkeletonResource.JointBuilder
struct · iOS 27.0+
SkinningDeformer
struct · iOS 27.0+
SpatialAudioComponent
struct · iOS 18.0+
SpatialForceFalloff
struct · iOS 18.0+
SpatialTrackingSession
class · iOS 18.0+
SpatialTrackingSession.Configuration
struct · iOS 18.0+
SpatialTrackingSession.Configuration.AnchorCapability
struct · iOS 18.0+
SpatialTrackingSession.Configuration.Camera
enum · iOS 18.0+
SpatialTrackingSession.Configuration.SceneUnderstandingCapability
struct · iOS 18.0+
SpatialTrackingSession.UnavailableCapabilities
struct · iOS 18.0+
SpinAction
struct · iOS 18.0+
SpinAction.EventParameterType
typealias · iOS 18.0+
SpotLight
class · iOS 13.0+
SpotLightComponent
struct · iOS 13.0+
SpotLightComponent.ProjectiveTexture
struct · iOS 27.0+
SpotLightComponent.ProjectiveTexture.TextureCoordinateTransform
typealias · iOS 27.0+
SpotLightComponent.Shadow
struct · iOS 13.0+
SpotLightComponent.Shadow.QualityMode
struct · iOS 27.0+
SpotLightComponent.Shadow.ShadowClippingPlane
enum · iOS 18.0+
SpotLightComponent.Shadow.ShadowMapCullMode
typealias · iOS 18.0+
SubdivisionSurfaceDeformer
struct · iOS 27.0+
SynchronizationComponent
struct · iOS 13.0+
SynchronizationComponent.OwnershipTransferCompletionResult
enum · iOS 13.0+
SynchronizationComponent.OwnershipTransferMode
enum · iOS 13.0+
SynchronizationEvents
enum · iOS 13.0+
SynchronizationEvents.OwnershipChanged
struct · iOS 13.0+
SynchronizationEvents.OwnershipRequest
struct · iOS 13.0+
SynchronizationPeerID
protocol · iOS 13.0+
SynchronizationService
protocol · iOS 13.0+
SynchronizationService.Identifier
typealias · iOS 13.0+
System
protocol · iOS 15.0+
SystemDependency
enum · iOS 15.0+
SystemUpdateCondition
struct · iOS 18.0+
TextComponent
struct · iOS 18.0+
TextureResource
class · iOS 13.0+
TextureResource.Compression
struct · iOS 18.0+
TextureResource.Compression.ASTCBlockSize
enum · iOS 18.0+
TextureResource.Compression.ASTCQuality
enum · iOS 18.0+
TextureResource.Contents
struct · iOS 18.0+
TextureResource.Contents.MipmapLevel
struct · iOS 18.0+
TextureResource.Contents.Slice
struct · iOS 18.0+
TextureResource.CreateOptions
struct · iOS 15.0+
TextureResource.Dimensions2D
struct · iOS 18.0+
TextureResource.Dimensions2DArray
struct · iOS 18.0+
TextureResource.Dimensions3D
struct · iOS 18.0+
TextureResource.DimensionsCube
struct · iOS 18.0+
TextureResource.Drawable
class · iOS 15.0+
TextureResource.DrawableQueue
class · iOS 15.0+
TextureResource.DrawableQueue.Descriptor
struct · iOS 15.0+
TextureResource.Format
struct · iOS 18.0+
TextureResource.Format.ColorSpace
enum · iOS 18.0+
TextureResource.Format.NormalEncoding
enum · iOS 18.0+
TextureResource.MipmapsMode
enum · iOS 15.0+
TextureResource.SamplingQuality
typealias · iOS 18.0+
TextureResource.Semantic
enum · iOS 15.0+
TimedForceFalloff
struct · iOS 18.0+
ToneMappingComponent
struct · iOS 27.0+
Transform
struct · iOS 13.0+
TransientComponent
protocol · iOS 15.0+
TriggerVolume
class · iOS 13.0+
TurbulenceForceEffect
struct · iOS 18.0+
TweenMode
enum · iOS 15.0+
UnlitLightingModel
struct · iOS 27.0+
UnlitMaterial
struct · iOS 13.0+
UnlitMaterial.BaseColor
typealias · iOS 15.0+
UnlitMaterial.Blending
typealias · iOS 15.0+
UnlitMaterial.FaceCulling
typealias · iOS 18.0+
UnlitMaterial.Parameters
typealias · iOS 15.0+
UnlitMaterial.Program
class · iOS 18.0+
UnlitMaterial.Program.Descriptor
struct · iOS 18.0+
UnlitMaterial.Texture
typealias · iOS 15.0+
UnlitMaterial.TextureCoordinateTransform
typealias · iOS 18.0+
UnlitMaterial.TriangleFillMode
typealias · iOS 18.0+
UnsafeForceEffectBuffer
struct · iOS 18.0+
UnsafeForceEffectBuffer.Element
typealias · iOS 18.0+
UnsafeForceEffectBuffer.Iterator
struct · iOS 18.0+
UnsafeForceEffectBuffer.Iterator.Element
typealias · iOS 18.0+
VideoMaterial
struct · iOS 14.0+
VideoMaterial.FaceCulling
typealias · iOS 18.0+
VideoMaterial.Parameters
typealias · iOS 15.0+
VideoMaterial.TriangleFillMode
typealias · iOS 18.0+
VideoPlaybackController
class · iOS 14.0+
VideoPlaybackController.ViewingMode
enum · iOS 18.0+
VideoPlayerComponent
struct · iOS 18.0+
VideoPlayerComponent.RenderingStatus
enum · iOS 18.0+
VideoPlayerEvents
enum · iOS 18.0+
VideoPlayerEvents.ContentTypeDidChange
struct · iOS 18.0+
VideoPlayerEvents.ContentTypeDidChange.ContentType
enum · iOS 18.0+
VideoPlayerEvents.ContentTypeDidChange.ContentType.RawValue
typealias · iOS 18.0+
VideoPlayerEvents.RenderingStatusDidChange
struct · iOS 18.0+
VideoPlayerEvents.VideoSizeDidChange
struct · iOS 18.0+
VideoPlayerEvents.ViewingModeDidChange
struct · iOS 18.0+
VirtualEnvironmentProbeComponent
struct · iOS 18.0+
VirtualEnvironmentProbeComponent.Influence
struct · iOS 27.0+
VirtualEnvironmentProbeComponent.Probe
struct · iOS 18.0+
VirtualEnvironmentProbeComponent.Source
enum · iOS 18.0+
VortexForceEffect
struct · iOS 18.0+
WorldComponent
struct · iOS 18.0+
Functions and constants
rate
TypeScriptget rate(): MeshBuffers_Ratevar rate: MeshBuffers.RateRate of the buffer.
rate
TypeScriptset rate(value: MeshBuffers_Rate)var rate: MeshBuffers.RateRate of the buffer.
count
TypeScriptget count(): numberlet count: IntThe number of elements in the buffer.
forEach
TypeScriptforEach(body: ((arg0: unknown, arg1: unknown) => void)): voidfunc forEach(_ body: (Element, Element) throws -> Void) rethrowsIterate over pairs of elements.
forEach
TypeScriptforEach21513(body: ((arg0: unknown, arg1: unknown, arg2: unknown) => void)): voidfunc forEach(_ body: (Element, Element, Element) throws -> Void) rethrowsIterate over three elements per step.
forEach
TypeScriptforEach51613(body: ((arg0: unknown, arg1: unknown, arg2: unknown, arg3: unknown) => void)): voidfunc forEach(_ body: (Element, Element, Element, Element) throws -> Void) rethrowsIterate over four elements per step.
next
TypeScriptnext(): (unknown) | nullmutating func next() -> Element?Advances to the next element and returns it, or `nil` if no next element exists. Repeatedly calling this method returns, in order, all the elements of the underlying sequence. As soon as the sequence has run out of elements, all subsequent calls return `nil`. You must not call this method if any other copy of this iterator has been advanced with a call to its `next()` method. The following example shows how an iterator can be used explicitly to emulate a `for`-`in` loop. First, retrieve a sequence's iterator, and then call the iterator's `next()` method until it returns `nil`. let numbers = [2, 3, 5, 7] var numbersIterator = numbers.makeIterator() while let num = numbersIterator.next() { print(num) } // Prints "2" // Prints "3" // Prints "5" // Prints "7" - Returns: The next element in the underlying sequence, if a next element exists; otherwise, `nil`.
elements
TypeScriptget elements(): Array<unknown>var elements: [Element] { get }Access the buffer as an array. This may create a copy if the data are not already an array.
usingRate
TypeScriptusingRate(rate: MeshBuffers_Rate): MeshBuffer<unknown>func usingRate(_ rate: MeshBuffers.Rate) -> MeshBuffer<Element>New object with updated rate.
init
TypeScriptstatic initElementsIndices(elements: Array<MeshJointInfluence>, indices: Array<number>): MeshBuffer<MeshJointInfluence>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init(array: Array<MeshJointInfluence>): MeshBuffer<MeshJointInfluence>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init29517(sequence: Array<MeshJointInfluence>): MeshBuffer<MeshJointInfluence>init<S>(_ sequence: S) where S : Sequence, S.Element == MeshJointInfluenceCreate a buffer from any sequence of elements.
init
TypeScriptstatic initElementsIndices78668(elements: Array<number>, indices: Array<number>): MeshBuffer<number>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init88685(array: Array<number>): MeshBuffer<number>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init65033(sequence: Array<number>): MeshBuffer<number>init<S>(_ sequence: S) where S : Sequence, S.Element == DoubleCreate a buffer from any sequence of elements.
init
TypeScriptstatic initElementsIndices64542(elements: Array<number>, indices: Array<number>): MeshBuffer<number>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init135(array: Array<number>): MeshBuffer<number>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init72179(sequence: Array<number>): MeshBuffer<number>init<S>(_ sequence: S) where S : Sequence, S.Element == FloatCreate a buffer from any sequence of elements.
init
TypeScriptstatic initElementsIndices28011(elements: Array<number>, indices: Array<number>): MeshBuffer<number>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init98876(array: Array<number>): MeshBuffer<number>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init2782(sequence: Array<number>): MeshBuffer<number>init<S>(_ sequence: S) where S : Sequence, S.Element == Int8Create a buffer from any sequence of elements.
init
TypeScriptstatic initElementsIndices24307(elements: Array<number>, indices: Array<number>): MeshBuffer<number>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init60084(array: Array<number>): MeshBuffer<number>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init57974(sequence: Array<number>): MeshBuffer<number>init<S>(_ sequence: S) where S : Sequence, S.Element == Int16Create a buffer from any sequence of elements.
init
TypeScriptstatic initElementsIndices91237(elements: Array<number>, indices: Array<number>): MeshBuffer<number>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init47678(array: Array<number>): MeshBuffer<number>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init81648(sequence: Array<number>): MeshBuffer<number>init<S>(_ sequence: S) where S : Sequence, S.Element == Int32Create a buffer from any sequence of elements.
init
TypeScriptstatic initElementsIndices73997(elements: Array<SDKHandle>, indices: Array<number>): MeshBuffer<SDKHandle>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init41694(array: Array<SDKHandle>): MeshBuffer<SDKHandle>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init90440(sequence: Array<SDKHandle>): MeshBuffer<SDKHandle>init<S>(_ sequence: S) where S : Sequence, S.Element == SIMD2<Float>Create a buffer from any sequence of elements.
init
TypeScriptstatic initElementsIndices76976(elements: Array<SDKHandle>, indices: Array<number>): MeshBuffer<SDKHandle>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init38361(array: Array<SDKHandle>): MeshBuffer<SDKHandle>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init33765(sequence: Array<SDKHandle>): MeshBuffer<SDKHandle>init<S>(_ sequence: S) where S : Sequence, S.Element == SIMD3<Float>Create a buffer from any sequence of elements.
init
TypeScriptstatic initElementsIndices76979(elements: Array<SDKHandle>, indices: Array<number>): MeshBuffer<SDKHandle>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init92700(array: Array<SDKHandle>): MeshBuffer<SDKHandle>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init42366(sequence: Array<SDKHandle>): MeshBuffer<SDKHandle>init<S>(_ sequence: S) where S : Sequence, S.Element == SIMD4<Float>Create a buffer from any sequence of elements.
init
TypeScriptstatic initElementsIndices18961(elements: Array<number>, indices: Array<number>): MeshBuffer<number>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init52026(array: Array<number>): MeshBuffer<number>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init47508(sequence: Array<number>): MeshBuffer<number>init<S>(_ sequence: S) where S : Sequence, S.Element == UInt8Create a buffer from any sequence of elements.
init
TypeScriptstatic initElementsIndices25249(elements: Array<number>, indices: Array<number>): MeshBuffer<number>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init6218(array: Array<number>): MeshBuffer<number>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init68(sequence: Array<number>): MeshBuffer<number>init<S>(_ sequence: S) where S : Sequence, S.Element == UInt16Create a buffer from any sequence of elements.
init
TypeScriptstatic initElementsIndices7199(elements: Array<number>, indices: Array<number>): MeshBuffer<number>init(elements: [Element], indices: [UInt32])Create buffer from an array of element values and an array of indices into that value array.
init
TypeScriptstatic init9720(array: Array<number>): MeshBuffer<number>init(_ array: [Element])Create buffer from an array of elements.
init
TypeScriptstatic init36754(sequence: Array<number>): MeshBuffer<number>init<S>(_ sequence: S) where S : Sequence, S.Element == UInt32Create a buffer from any sequence of elements.
targetEntity
TypeScriptget targetEntity(): (Entity) | nulllet targetEntity: Entity?The entity the bind target references. For example, if a bind target references an entity's transform (i.e. `.transform`), this value is set to that entity. This may differ from the entity property in the playback controller if the bind target references an entity other than the entity that the animation was played on.
animationState
TypeScriptget animationState(): (SDKHandle) | nullvar animationState: (any AnimationStateProtocol)? { get }The animation state for the action. Used to procedurally animate a target value with cross-fading, and additive blending support. The animation state is available when a bind target along with its type is defined for the action. (See ``AnimationStateProtocol``) The following example returns an animated value to the animation system for the current frame by storing its value within the returned animation state. ```swift MyCustomAction.subscribe(.updated) { event in // The returned state will be nil // if the action animation's bind target, and type is not defined. guard let animationState = event.animationState else { return } animationState.storeAnimatedValue(myAnimatedResult) } ```
playbackController
TypeScriptget playbackController(): AnimationPlaybackControllerlet playbackController: AnimationPlaybackControllerThe animation playback controller that manages the animation executing the action.
duration
TypeScriptget duration(): numberlet duration: TimeIntervalThe duration of the the event.
reversed
TypeScriptget reversed(): booleanlet reversed: BoolA Boolean value that indicates reverse playback when true.
startTime
TypeScriptget startTime(): numberlet startTime: TimeIntervalThe start time of the current event.
orientation
TypeScriptget orientation(): SDKHandlevar orientation: simd_quatfRotation of the force effect relative to the effect's transform component.
orientation
TypeScriptset orientation(value: SDKHandle)var orientation: simd_quatfRotation of the force effect relative to the effect's transform component.
timedFalloff
TypeScriptget timedFalloff(): (TimedForceFalloff) | nullvar timedFalloff: TimedForceFalloff?Optional strength falloff based on the duration of the effect.
timedFalloff
TypeScriptset timedFalloff(value: (TimedForceFalloff) | null)var timedFalloff: TimedForceFalloff?Optional strength falloff based on the duration of the effect.
strengthScale
TypeScriptget strengthScale(): numbervar strengthScale: FloatA multiplier that scales the strength of the effect.
strengthScale
TypeScriptset strengthScale(value: number)var strengthScale: FloatA multiplier that scales the strength of the effect.
spatialFalloff
TypeScriptget spatialFalloff(): (SpatialForceFalloff) | nullvar spatialFalloff: SpatialForceFalloff?Optional strength falloff based on the spatial bounds of the effect.
spatialFalloff
TypeScriptset spatialFalloff(value: (SpatialForceFalloff) | null)var spatialFalloff: SpatialForceFalloff?Optional strength falloff based on the spatial bounds of the effect.
mask
TypeScriptget mask(): CollisionGroupvar mask: CollisionGroupControls which collision groups will be affected by this force effect.
mask
TypeScriptset mask(value: CollisionGroup)var mask: CollisionGroupControls which collision groups will be affected by this force effect.
position
TypeScriptget position(): SDKHandlevar position: SIMD3<Float>Position of the force effect relative to the effect's transform component.
position
TypeScriptset position(value: SDKHandle)var position: SIMD3<Float>Position of the force effect relative to the effect's transform component.
result
TypeScriptget result(): (SDKHandle) | nullvar result: Result<Output, any Error>? { get }The result of the load operation. A load operation can have the following results: - `success(Output)` ... The load operation has completed successfully. - `failure(Error)` ... The load operation failed. - `nil` ... The load operation is still in progress.
id
TypeScriptget id(): MeshBuffers_Identifierlet id: MeshBuffers.IdentifierThe stable identity of the entity associated with this instance.
makeIterator
TypeScriptmakeIterator(): QueryResult_Iterator<unknown>func makeIterator() -> QueryResult<Element>.IteratorReturns an iterator for the contained entities. - Returns: The iterator.
next
TypeScriptnext(): (unknown) | nullmutating func next() -> Element?Advances to the next entity and returns it. - Returns: Calling this method advances the iterator to the next entity and returns it. If there is no next element, returns `nil`.
baseValue
TypeScriptget baseValue(): numbervar baseValue: TA value that reflects the state of the animated property before or after an animation.
baseValue
TypeScriptset baseValue(value: number)var baseValue: TA value that reflects the state of the animated property before or after an animation.
animatedValue
TypeScriptget animatedValue(): (number) | nullvar animatedValue: T?A value that represents the state of the animated property as an animation progresses.
animatedValue
TypeScriptset animatedValue(value: (number) | null)var animatedValue: T?A value that represents the state of the animated property as an animation progresses.
value
TypeScriptget value(): numbervar value: T { get set }The main accessor for the bind value. This property returns the animated value (``BindableValue/animatedValue``) if an animation is active. Otherwise, this property returns the base value (``BindableValue/baseValue``). When you assign a value to this property, the setter assigns the value you provide to ``BindableValue/baseValue``.
value
TypeScriptset value(value: number)var value: T { get set }The main accessor for the bind value. This property returns the animated value (``BindableValue/animatedValue``) if an animation is active. Otherwise, this property returns the base value (``BindableValue/baseValue``). When you assign a value to this property, the setter assigns the value you provide to ``BindableValue/baseValue``.
init
TypeScriptstatic init(value: number, animatedValue?: (number) | null): BindableValue<number>init(_ value: T, animatedValue: T? = nil)Creates a bindable value. - Parameters: - value: A value that reflects the state of the animated property before or after an animation. - animatedValue: A value that represents the state of the animated property as an animation progresses.
defaultSource
TypeScriptget defaultSource(): (number) | nullvar defaultSource: Value? { get }See: ``AnimationStateProtocol/defaultSource``
defaultTarget
TypeScriptget defaultTarget(): (number) | nullvar defaultTarget: Value? { get }See: ``AnimationStateProtocol/defaultTarget``
evaluationTime
TypeScriptget evaluationTime(): numberlet evaluationTime: TimeIntervalSee ``AnimationStateProtocol/evaluationTime``
normalizedTime
TypeScriptget normalizedTime(): numberlet normalizedTime: TimeIntervalSee ``AnimationStateProtocol/normalizedTime``
storeAnimatedValue
TypeScriptstoreAnimatedValue(value: unknown): boolean@discardableResult func storeAnimatedValue<ValueType>(_ value: ValueType) -> BoolSee: ``AnimationStateProtocol/storeAnimatedValue(_:)``
deltaTime
TypeScriptget deltaTime(): numberlet deltaTime: TimeIntervalSee: ``AnimationStateProtocol/deltaTime``
defaultSource
TypeScriptget defaultSource93890(): (JointTransforms) | nullvar defaultSource: JointTransforms? { get }Returns the joint transforms representing the default source value. See ``AnimationStateProtocol/defaultSource`` for more about the default source value.
defaultTarget
TypeScriptget defaultTarget39026(): (JointTransforms) | nullvar defaultTarget: JointTransforms? { get }Returns the joint transforms representing the default target value. See: ``AnimationStateProtocol/defaultTarget``
defaultSourceJoints
TypeScriptdefaultSourceJoints(index: number, count: number, transforms: Array<Transform>): { $ret: boolean; $out: { "transforms": Array<Transform> } }func defaultSourceJoints(index: Int, count: Int, transforms: inout [Transform]) -> BoolRetrieves a subset of default source joints, and stores them in the output transform array. See ``AnimationStateProtocol/defaultSource`` for more about the default source value.
Omit the output parameters from the call. The result contains $ret and $out, with transforms inside $out.
defaultTargetJoints
TypeScriptdefaultTargetJoints(index: number, count: number, transforms: Array<Transform>): { $ret: boolean; $out: { "transforms": Array<Transform> } }func defaultTargetJoints(index: Int, count: Int, transforms: inout [Transform]) -> BoolRetrieves a subset of default target joints, and stores them in the output transform array. See ``AnimationStateProtocol/defaultTarget`` for more about the default target value.
Omit the output parameters from the call. The result contains $ret and $out, with transforms inside $out.
storeAnimatedJoints
TypeScriptstoreAnimatedJoints(transforms: Array<Transform>, jointIndex: number): boolean@discardableResult func storeAnimatedJoints(transforms: [Transform], jointIndex: Int) -> BoolStores a subset of animated joints. See ``AnimationStateProtocol/storeAnimatedValue(_:)`` for more about returning an animation result to the animation system.
isAdditive
TypeScriptget isAdditive(): booleanvar isAdditive: BoolA Boolean value that indicates whether the animation system additively blends the action's output with the base value.
isAdditive
TypeScriptset isAdditive(value: boolean)var isAdditive: BoolA Boolean value that indicates whether the animation system additively blends the action's output with the base value.
isReversible
TypeScriptget isReversible(): booleanlet isReversible: BoolSpecifies whether you can play this action in reverse in order to undo prior operations.
default
TypeScriptstatic get default(): FromToByAction_TransformMode<number>static var `default`: FromToByAction<Value>.TransformMode { get }Default transform mode used by the specializations which use transform mode.
timingFunction
TypeScriptget timingFunction(): AnimationTimingFunctionvar timingFunction: AnimationTimingFunctionA timing function that controls the progress of the animation.
timingFunction
TypeScriptset timingFunction(value: AnimationTimingFunction)var timingFunction: AnimationTimingFunctionA timing function that controls the progress of the animation.
by
TypeScriptget by(): (number) | nulllet by: Value?The amount that the animated property changes during the animation.
init
TypeScriptstatic initToByTimingIsAdditive(to: number, by: number, timing?: AnimationTimingFunction, isAdditive?: boolean): FromToByAction<number>init(to: Value, by: Value, timing: AnimationTimingFunction = .linear, isAdditive: Bool = false)Creates a new from to by action to animate towards a final value. The starting value is determined by adding the inverse of `by` to the specified final value. `to - by` → `to` - Parameters: - to: Value set at the end of the animation. - by: Value used to determine the starting value, relative to the end value. - timing: Controls the progress of the animation. - isAdditive: Specifies whether you can additively blend the output from the action's animation.
to
TypeScriptget to(): (number) | nulllet to: Value?The state of the animated property after the animation ends. When the value is `nil`, the system uses the default source value.
init
TypeScriptstatic initFromByTimingIsAdditive(from: (number) | null, by: number, timing?: AnimationTimingFunction, isAdditive?: boolean): FromToByAction<number>init(from: Value? = nil, by: Value, timing: AnimationTimingFunction = .linear, isAdditive: Bool = false)Creates a new action that interpolates towards a specified value, which is relative to the starting value. `from` → `from + by` or `defaultSource` → `defaultSource + by` - Parameters: - from: Value set at the start of the animation, or `nil` to use the default source. - by: Value relative to the initial value to determine the final value. - timing: Controls the progress of the animation. - isAdditive: Specifies whether you can additively blend the output from the action's animation.
init
TypeScriptstatic initFromToTimingIsAdditive(from: (number) | null, to: number, timing?: AnimationTimingFunction, isAdditive?: boolean): FromToByAction<number>init(from: Value? = nil, to: Value, timing: AnimationTimingFunction = .linear, isAdditive: Bool = false)Creates a new action that interpolates towards a specified final value. `from` → `to` or `defaultSource` → `to` - Parameters: - from: Value set at the start of the animation, or `nil` to use the default source. - to: Value set at the end of the animation. - timing: Controls the progress of the animation. - isAdditive: A Boolean value that indicates whether the animation system additively blends the action's output with the base value.
init
TypeScriptstatic initFromTimingIsAdditive(from: number, timing?: AnimationTimingFunction, isAdditive?: boolean): FromToByAction<number>init(from: Value, timing: AnimationTimingFunction = .linear, isAdditive: Bool = false)Creates a new from to by action to animate from a specified value, towards the defaultSource value. `from` → `defaultSource` - Parameters: - from: Value set at the start of the animation. - timing: Controls the progress of the animation. - isAdditive: Specifies whether you can additively blend the output from the action's animation.
from
TypeScriptget from(): (number) | nulllet from: Value?The state of the animated property before the animation starts. When the value is `nil`, the system uses the default source value.
init
TypeScriptstatic initByTimingIsAdditive(by: Transform, timing?: AnimationTimingFunction, isAdditive?: boolean): FromToByAction<Transform>init(by: Value, timing: AnimationTimingFunction = .linear, isAdditive: Bool = false)Creates a new action to animate from the deaultSource by a transform relative to the starting transform. `defaultSource` → `defaultSource + by` - Parameters: - by: Transform which is used to increment the starting transform. Used to determine the final transform we animate towards. - timing: Controls the progress of the animation. - isAdditive: Specifies whether you can additively blend the output from the action's animation.
init
TypeScriptstatic initToByModeTimingIsAdditive(to: Transform, by: Transform, mode?: FromToByAction_TransformMode<Transform>, timing?: AnimationTimingFunction, isAdditive?: boolean): FromToByAction<Transform>init(to: Value, by: Value, mode: FromToByAction<Value>.TransformMode = .default, timing: AnimationTimingFunction = .linear, isAdditive: Bool = false)Creates a action to animate towards a final value. The starting value is determined by adding the inverse of `by` to the specified final value. `to - by` → `to` - Parameters: - to: Value set at the end of the animation. - by: Value used to determine the starting value, relative to the end value. - mode: Determines what space the transforms are relative to. - timing: Controls the progress of the animation. - isAdditive: Specifies whether you can additively blend the output from the action's animation.
init
TypeScriptstatic initFromByModeTimingIsAdditive(from: Transform, by?: (Transform) | null, mode?: FromToByAction_TransformMode<Transform>, timing?: AnimationTimingFunction, isAdditive?: boolean): FromToByAction<Transform>init(from: Value, by: Value? = nil, mode: FromToByAction<Value>.TransformMode = .default, timing: AnimationTimingFunction = .linear, isAdditive: Bool = false)Creates a new action that interpolates from a specified starting transform towards a specified transform, which is relative to the start. Alternatively, interpolates towards the default source if `by` is not supplied. `from` → `from + by` or `from` → `defaultSource` - Parameters: - from: Transform set at the start of the animation. - by: Transform which is used to increment the starting transform. Used to determine the final transform we animate towards. Set this to `nil` to animate towards the defaultSource transform. - mode: Determines what space the transforms are relative to. - timing: Controls the progress of the animation. - isAdditive: Specifies whether you can additively blend the output from the action's animation.
init
TypeScriptstatic initFromToModeTimingIsAdditive(from: (Transform) | null, to: Transform, mode?: FromToByAction_TransformMode<Transform>, timing?: AnimationTimingFunction, isAdditive?: boolean): FromToByAction<Transform>init(from: Value? = nil, to: Value, mode: FromToByAction<Value>.TransformMode = .default, timing: AnimationTimingFunction = .linear, isAdditive: Bool = false)Creates a new action that interpolates towards a specified final transform. `defaultSource` → `to` or `defaultSource` → `to` - Parameters: - from: Transform set at the start of the animation, or `nil` to use the default source. - to: Transform set at the end of the animation. - mode: Determines what space the transforms are relative to. - timing: Controls the progress of the animation. - isAdditive: Specifies whether you can additively blend the output from the action's animation.
mode
TypeScriptget mode(): (FromToByAction_TransformMode<Transform>) | nullvar mode: FromToByAction<Transform>.TransformMode? { get }Determines the entities transform ``FromToByAction/from`` and ``FromToByAction/to`` are relative to. - Note: The expection to this mode is `by`. This property is relative to the starting value, Set this to `nil` if only `by` is specified.
bindTarget
TypeScriptget bindTarget(): BindTargetvar bindTarget: BindTarget { get set }``AnimationDefinition/bindTarget`` is not used.
bindTarget
TypeScriptset bindTarget(value: BindTarget)var bindTarget: BindTarget { get set }``AnimationDefinition/bindTarget`` is not used.
blendLayer
TypeScriptget blendLayer(): numbervar blendLayer: Int32 { get set }``AnimationDefinition/blendLayer`` is not used.
blendLayer
TypeScriptset blendLayer(value: number)var blendLayer: Int32 { get set }``AnimationDefinition/blendLayer`` is not used.
repeatMode
TypeScriptget repeatMode(): AnimationRepeatModevar repeatMode: AnimationRepeatMode { get set }An option that determines how the animation repeats. If you call ``AnimationAction/trimmed(start:end:duration:)`` with a `start` or `end` that lies outside of the timeline defined by ``AnimationAction/duration``, the animation fills the additional playback by applying this property.
repeatMode
TypeScriptset repeatMode(value: AnimationRepeatMode)var repeatMode: AnimationRepeatMode { get set }An option that determines how the animation repeats. If you call ``AnimationAction/trimmed(start:end:duration:)`` with a `start` or `end` that lies outside of the timeline defined by ``AnimationAction/duration``, the animation fills the additional playback by applying this property.
trimDuration
TypeScriptget trimDuration(): (number) | nullvar trimDuration: TimeInterval? { get set }An optional duration that overrides the calculated duration. The framework calculates ``AnimationAction/duration``, but you can set this property to override it. This property is `nil` by default, which indicates that the animation stops after one play that spans ``AnimationAction/duration``. If you set a non-zero value for this property and both ``AnimationAction/trimStart`` and ``AnimationAction/trimEnd`` are `nil`, the animation observes this property as an edited duration. When you set ``AnimationAction/repeatMode`` to make the animation repeat: - If this property is `nil`, the animation repeats forever. - If set to a value greater than ``AnimationAction/duration``, the animation repeats for the specified duration.
trimDuration
TypeScriptset trimDuration(value: (number) | null)var trimDuration: TimeInterval? { get set }An optional duration that overrides the calculated duration. The framework calculates ``AnimationAction/duration``, but you can set this property to override it. This property is `nil` by default, which indicates that the animation stops after one play that spans ``AnimationAction/duration``. If you set a non-zero value for this property and both ``AnimationAction/trimStart`` and ``AnimationAction/trimEnd`` are `nil`, the animation observes this property as an edited duration. When you set ``AnimationAction/repeatMode`` to make the animation repeat: - If this property is `nil`, the animation repeats forever. - If set to a value greater than ``AnimationAction/duration``, the animation repeats for the specified duration.
eventDefinitions
TypeScriptget eventDefinitions(): Array<ActionEventDefinition<SDKHandle>>var eventDefinitions: [ActionEventDefinition<ActionType>] { get set }The event interval definitions, and their associated parameter data.
eventDefinitions
TypeScriptset eventDefinitions(value: Array<ActionEventDefinition<SDKHandle>>)var eventDefinitions: [ActionEventDefinition<ActionType>] { get set }The event interval definitions, and their associated parameter data.
name
TypeScriptget name(): stringvar name: String { get set }A textual name for the animation.
name
TypeScriptset name(value: string)var name: String { get set }A textual name for the animation.
delay
TypeScriptget delay(): numbervar delay: TimeInterval { get set }An amount of time that lapses before the animation plays. The default value is `0`, which indicates that the animation plays with no delay. If you set a value for this property, the animation plays from its start time after the specified delay lapses. During the delayed time, the animation doesn't update. However, to fill the delayed time with some portion of animation, set a negative ``AnimationAction/trimStart`` instead and choose a ``AnimationAction/fillMode`` that displays the desired portion of animation.
delay
TypeScriptset delay(value: number)var delay: TimeInterval { get set }An amount of time that lapses before the animation plays. The default value is `0`, which indicates that the animation plays with no delay. If you set a value for this property, the animation plays from its start time after the specified delay lapses. During the delayed time, the animation doesn't update. However, to fill the delayed time with some portion of animation, set a negative ``AnimationAction/trimStart`` instead and choose a ``AnimationAction/fillMode`` that displays the desired portion of animation.
speed
TypeScriptget speed(): numbervar speed: Float { get set }A factor that changes the animation’s rate of playback. The default value is `1.0`, which doesn’t alter the animation’s duration. A value of `2.0` indicates that the duration is half the normal rate. A value of `0.5` indicates that the duration is twice the normal rate. Negative values play the animation in reverse. This property doesn’t affect the animation’s ``FromToByAnimation/delay``.
speed
TypeScriptset speed(value: number)var speed: Float { get set }A factor that changes the animation’s rate of playback. The default value is `1.0`, which doesn’t alter the animation’s duration. A value of `2.0` indicates that the duration is half the normal rate. A value of `0.5` indicates that the duration is twice the normal rate. Negative values play the animation in reverse. This property doesn’t affect the animation’s ``FromToByAnimation/delay``.
offset
TypeScriptget offset(): numbervar offset: TimeInterval { get set }The time, in seconds, at which the animation begins within the duration. The default value is `0`, which indicates that the animation plays with no offset. Setting a value for this property moves the animation data along the timeline and doesn't change timing. If you set a ``AnimationAction/fillMode`` other than ``AnimationFillMode/none``, the animation fills the vacant area created by the offset according to the characteristics of the specified fill mode.
offset
TypeScriptset offset(value: number)var offset: TimeInterval { get set }The time, in seconds, at which the animation begins within the duration. The default value is `0`, which indicates that the animation plays with no offset. Setting a value for this property moves the animation data along the timeline and doesn't change timing. If you set a ``AnimationAction/fillMode`` other than ``AnimationFillMode/none``, the animation fills the vacant area created by the offset according to the characteristics of the specified fill mode.
trimEnd
TypeScriptget trimEnd(): (number) | nullvar trimEnd: TimeInterval? { get set }The optional time, in seconds, at which the animation stops. This property is `nil` by default, which plays the animation until `time` = ``AnimationGroup/duration``. If you set a value, the animation edits the duration according to the specified ending time.
trimEnd
TypeScriptset trimEnd(value: (number) | null)var trimEnd: TimeInterval? { get set }The optional time, in seconds, at which the animation stops. This property is `nil` by default, which plays the animation until `time` = ``AnimationGroup/duration``. If you set a value, the animation edits the duration according to the specified ending time.
duration
TypeScriptget duration(): numbervar duration: TimeInterval { get }The elapsed time for one complete rotation. The framework sets a value for this property depending on the underlying animation data and the specified ``AnimationAction/speed``. You can override the default duration by defining ``AnimationAction/trimStart``, ``AnimationAction/trimEnd``, or ``AnimationAction/trimDuration``.
fillMode
TypeScriptget fillMode(): AnimationFillModevar fillMode: AnimationFillMode { get set }An option that determines which data displays outside of the normal duration. This property determines what to display when the framework samples the animation outside of the range defined by its underlying duration. The animation applies this property when: - Playback progresses toward, but hasn't yet reached, a nonzero ``AnimationDefinition/offset``. - A range determined by ``AnimationDefinition/trimStart``, ``AnimationDefinition/trimEnd``, or ``AnimationDefinition/trimDuration`` exceeds the animation's underlying duration.
fillMode
TypeScriptset fillMode(value: AnimationFillMode)var fillMode: AnimationFillMode { get set }An option that determines which data displays outside of the normal duration. This property determines what to display when the framework samples the animation outside of the range defined by its underlying duration. The animation applies this property when: - Playback progresses toward, but hasn't yet reached, a nonzero ``AnimationDefinition/offset``. - A range determined by ``AnimationDefinition/trimStart``, ``AnimationDefinition/trimEnd``, or ``AnimationDefinition/trimDuration`` exceeds the animation's underlying duration.
trimStart
TypeScriptget trimStart(): (number) | nullvar trimStart: TimeInterval? { get set }The optional time, in seconds, at which the animation plays. This property is `nil` by default, which plays the animation with `time` = `0`. If you set a value, the animation edits the duration according to the specified beginning time. If you set a negative value for this property, the duration increases and the additional animation data fills in based on the ``AnimationView/fillMode`` you choose.
trimStart
TypeScriptset trimStart(value: (number) | null)var trimStart: TimeInterval? { get set }The optional time, in seconds, at which the animation plays. This property is `nil` by default, which plays the animation with `time` = `0`. If you set a value, the animation edits the duration according to the specified beginning time. If you set a negative value for this property, the duration increases and the additional animation data fills in based on the ``AnimationView/fillMode`` you choose.
parameters
TypeScriptget parameters(): ForceEffectParametersvar parameters: ForceEffectParametersPhysics body parameters.
parameters
TypeScriptset parameters(value: ForceEffectParameters)var parameters: ForceEffectParametersPhysics body parameters.
bindTarget
TypeScriptget bindTarget(): BindTargetvar bindTarget: BindTarget { get set }A textual name that identifies the particular property that animates. The property name is a key path. For more information on key paths, see <doc://com.apple.documentation/documentation/swift/swift_standard_library/key-path_expressions>.
bindTarget
TypeScriptset bindTarget(value: BindTarget)var bindTarget: BindTarget { get set }A textual name that identifies the particular property that animates. The property name is a key path. For more information on key paths, see <doc://com.apple.documentation/documentation/swift/swift_standard_library/key-path_expressions>.
blendLayer
TypeScriptget blendLayer(): numbervar blendLayer: Int32 { get set }The order in which the framework composites the animation. The framework applies multiple animations on the same target in ascending order of this property’s value. Animations in a lower layer run before animations in a higher layer. Animations that share the same value apply in the order that they execute.
blendLayer
TypeScriptset blendLayer(value: number)var blendLayer: Int32 { get set }The order in which the framework composites the animation. The framework applies multiple animations on the same target in ascending order of this property’s value. Animations in a lower layer run before animations in a higher layer. Animations that share the same value apply in the order that they execute.
repeatMode
TypeScriptget repeatMode(): AnimationRepeatModevar repeatMode: AnimationRepeatMode { get set }An option that determines how the animation repeats. If you call ``SampledAnimation/trimmed(start:end:duration:)`` with a `start` or `end` that lies outside of the timeline defined by ``SampledAnimation/duration``, the animation fills the additional playback by applying this property.
repeatMode
TypeScriptset repeatMode(value: AnimationRepeatMode)var repeatMode: AnimationRepeatMode { get set }An option that determines how the animation repeats. If you call ``SampledAnimation/trimmed(start:end:duration:)`` with a `start` or `end` that lies outside of the timeline defined by ``SampledAnimation/duration``, the animation fills the additional playback by applying this property.
trimDuration
TypeScriptget trimDuration(): (number) | nullvar trimDuration: TimeInterval? { get set }An optional duration that overrides the calculated duration. This property is `nil` by default, which indicates that the animation stops after one play that spans ``SampledAnimation/duration``. If you set a non-zero value for this property and both ``SampledAnimation/trimStart`` and ``SampledAnimation/trimEnd`` are `nil`, the animation observes this property as an edited duration. When you set ``SampledAnimation/repeatMode`` to make the animation repeat: - If this property is `nil`, the animation repeats forever. - If set to a value greater than ``SampledAnimation/duration``, the animation repeats for the specified duration.
trimDuration
TypeScriptset trimDuration(value: (number) | null)var trimDuration: TimeInterval? { get set }An optional duration that overrides the calculated duration. This property is `nil` by default, which indicates that the animation stops after one play that spans ``SampledAnimation/duration``. If you set a non-zero value for this property and both ``SampledAnimation/trimStart`` and ``SampledAnimation/trimEnd`` are `nil`, the animation observes this property as an edited duration. When you set ``SampledAnimation/repeatMode`` to make the animation repeat: - If this property is `nil`, the animation repeats forever. - If set to a value greater than ``SampledAnimation/duration``, the animation repeats for the specified duration.
frameInterval
TypeScriptget frameInterval(): numbervar frameInterval: Float { get set }The duration within the animation timeline for each frame in the frames array.
frameInterval
TypeScriptset frameInterval(value: number)var frameInterval: Float { get set }The duration within the animation timeline for each frame in the frames array.
end
TypeScriptget end(): numbervar end: TimeInterval { get set }An integer multiple of the frame interval at which the animation stops. When calculating the visual beginning of a sampled animation, the framework first evaluates this property, and then applies the optional ``SampledAnimation/trimEnd``, in seconds. The framework requires this property to contain an integer multiple of ``SampledAnimation/frameInterval``. Note that the value of this property can be irrational because frame interval is of type <doc://com.apple.documentation/documentation/foundation/timeinterval>.
end
TypeScriptset end(value: number)var end: TimeInterval { get set }An integer multiple of the frame interval at which the animation stops. When calculating the visual beginning of a sampled animation, the framework first evaluates this property, and then applies the optional ``SampledAnimation/trimEnd``, in seconds. The framework requires this property to contain an integer multiple of ``SampledAnimation/frameInterval``. Note that the value of this property can be irrational because frame interval is of type <doc://com.apple.documentation/documentation/foundation/timeinterval>.
name
TypeScriptget name(): stringvar name: String { get set }A textual name for the animation.
name
TypeScriptset name(value: string)var name: String { get set }A textual name for the animation.
delay
TypeScriptget delay(): numbervar delay: TimeInterval { get set }An amount of time that elapses before the animation plays. The default value is `0`, which indicates that the animation plays with no delay. If you set a value for this property, the animation plays from its start time after the specified delay lapses. During the delayed time, the animation doesn't update. However, to fill the delayed time with some portion of animation, set a negative ``SampledAnimation/trimStart`` instead and choose a ``SampledAnimation/fillMode`` that displays the desired portion of animation.
delay
TypeScriptset delay(value: number)var delay: TimeInterval { get set }An amount of time that elapses before the animation plays. The default value is `0`, which indicates that the animation plays with no delay. If you set a value for this property, the animation plays from its start time after the specified delay lapses. During the delayed time, the animation doesn't update. However, to fill the delayed time with some portion of animation, set a negative ``SampledAnimation/trimStart`` instead and choose a ``SampledAnimation/fillMode`` that displays the desired portion of animation.
speed
TypeScriptget speed(): numbervar speed: Float { get set }A factor that changes the animation’s rate of playback. The default value is `1.0`, which doesn’t alter the animation’s duration. A value of `2.0` indicates that the duration is half the normal rate. A value of `0.5` indicates that the duration is twice the normal rate. Negative values play the animation in reverse. This property doesn’t affect the animation’s ``SampledAnimation/delay``.
speed
TypeScriptset speed(value: number)var speed: Float { get set }A factor that changes the animation’s rate of playback. The default value is `1.0`, which doesn’t alter the animation’s duration. A value of `2.0` indicates that the duration is half the normal rate. A value of `0.5` indicates that the duration is twice the normal rate. Negative values play the animation in reverse. This property doesn’t affect the animation’s ``SampledAnimation/delay``.
start
TypeScriptget start(): numbervar start: TimeInterval { get set }An integer multiple of the frame interval at which the animation plays. When calculating the visual beginning of a sampled animation, the framework first evaluates this property, and then applies the optional ``SampledAnimation/trimStart``, in seconds. The framework requires this property to contain an integer multiple of ``SampledAnimation/frameInterval``. Note that the value of this property can be irrational because frame interval is of type <doc://com.apple.documentation/documentation/foundation/timeinterval>.
start
TypeScriptset start(value: number)var start: TimeInterval { get set }An integer multiple of the frame interval at which the animation plays. When calculating the visual beginning of a sampled animation, the framework first evaluates this property, and then applies the optional ``SampledAnimation/trimStart``, in seconds. The framework requires this property to contain an integer multiple of ``SampledAnimation/frameInterval``. Note that the value of this property can be irrational because frame interval is of type <doc://com.apple.documentation/documentation/foundation/timeinterval>.
init
TypeScriptstatic initFramesNameTweenModeFrameIntervalIsAdditiveBindTargetBlendLayerRepeatModeFillModeTrimStartTrimEndTrimDurationOffsetDelaySpeed(frames: Array<number>, name?: string, tweenMode?: TweenMode, frameInterval?: number, isAdditive?: boolean, bindTarget?: (BindTarget) | null, blendLayer?: number, repeatMode?: AnimationRepeatMode, fillMode?: AnimationFillMode, trimStart?: (number) | null, trimEnd?: (number) | null, trimDuration?: (number) | null, offset?: number, delay?: number, speed?: number): SampledAnimation<number>init(frames: [Value], name: String = "", tweenMode: TweenMode = .linear, frameInterval: Float = 1.0 / 30.0, isAdditive: Bool = false, bindTarget: BindTarget? = nil, blendLayer: Int32 = 0, repeatMode: AnimationRepeatMode = .none, fillMode: AnimationFillMode = [], trimStart: TimeInterval? = nil, trimEnd: TimeInterval? = nil, trimDuration: TimeInterval? = nil, offset: TimeInterval = 0, delay: TimeInterval = 0, speed: Float = 1.0)Creates an animation with a collection of frames that represent incremental steps in the overall timeline. - Parameters: - frames: An array of values in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. - name: A textual name for the animation. - tweenMode: An option that determines how animation frames transition. - frameInterval: The duration within the animation timeline for each frame in the frames array. - isAdditive: A Boolean value that indicates whether the animation builds on the current state of the target entity or resets the state before running. - bindTarget: A textual name that identifies the particular property that animates. - blendLayer: The order in which the framework composites the animation into the view. - repeatMode: An option that determines how the animation repeats. - fillMode: The playback behavior outside of the normal duration. - trimStart: The optional time, in seconds, at which the animation plays. - trimEnd: The optional time, in seconds, at which the animation stops. - trimDuration: An optional duration that overrides the calculated duration. - offset: The time, in seconds, at which the animation begins within the duration. - delay: An amount of time that elapses before the animation plays. - speed: A factor that changes the animation’s rate of playback.
offset
TypeScriptget offset(): numbervar offset: TimeInterval { get set }The time, in seconds, at which the animation begins within the duration. The default value is `0`, which indicates that the animation plays with no offset. Setting a value for this property moves the animation data along the timeline and doesn't change timing. If you set a ``SampledAnimation/fillMode`` other than ``AnimationFillMode/none``, the animation fills the vacant area created by the offset according to the characteristics of the specified fill mode.
offset
TypeScriptset offset(value: number)var offset: TimeInterval { get set }The time, in seconds, at which the animation begins within the duration. The default value is `0`, which indicates that the animation plays with no offset. Setting a value for this property moves the animation data along the timeline and doesn't change timing. If you set a ``SampledAnimation/fillMode`` other than ``AnimationFillMode/none``, the animation fills the vacant area created by the offset according to the characteristics of the specified fill mode.
trimEnd
TypeScriptget trimEnd(): (number) | nullvar trimEnd: TimeInterval? { get set }The optional time, in seconds, at which the animation stops. This property is `nil` by default, which plays the animation until the ``SampledAnimation/end`` frame interval. If you set a value, the animation subtracts an additional seconds duration from the animation data that the ``SampledAnimation/end`` frame interval references.
trimEnd
TypeScriptset trimEnd(value: (number) | null)var trimEnd: TimeInterval? { get set }The optional time, in seconds, at which the animation stops. This property is `nil` by default, which plays the animation until the ``SampledAnimation/end`` frame interval. If you set a value, the animation subtracts an additional seconds duration from the animation data that the ``SampledAnimation/end`` frame interval references.
additive
TypeScriptget additive(): booleanvar additive: Bool { get set }A Boolean value that indicates whether the animation builds on the current state of the target entity or resets the state before running.
additive
TypeScriptset additive(value: boolean)var additive: Bool { get set }A Boolean value that indicates whether the animation builds on the current state of the target entity or resets the state before running.
duration
TypeScriptget duration(): numbervar duration: TimeInterval { get set }The total playback time of the animation. The framework sets a value for this property depending on the underlying animation data and the specified ``SampledAnimation/speed``. You can override the default duration by defining ``SampledAnimation/trimStart``, ``SampledAnimation/trimEnd``, or ``SampledAnimation/trimDuration``.
duration
TypeScriptset duration(value: number)var duration: TimeInterval { get set }The total playback time of the animation. The framework sets a value for this property depending on the underlying animation data and the specified ``SampledAnimation/speed``. You can override the default duration by defining ``SampledAnimation/trimStart``, ``SampledAnimation/trimEnd``, or ``SampledAnimation/trimDuration``.
fillMode
TypeScriptget fillMode(): AnimationFillModevar fillMode: AnimationFillMode { get set }An option that determines which data displays outside of the normal duration. This property determines what to display when the framework samples the animation outside of the range defined by its underlying duration. The animation applies this property when: - Playback progresses toward, but hasn't yet reached, a nonzero ``AnimationDefinition/offset``. - A range determined by ``AnimationDefinition/trimStart``, ``AnimationDefinition/trimEnd``, or ``AnimationDefinition/trimDuration`` exceeds the animation's underlying duration.
fillMode
TypeScriptset fillMode(value: AnimationFillMode)var fillMode: AnimationFillMode { get set }An option that determines which data displays outside of the normal duration. This property determines what to display when the framework samples the animation outside of the range defined by its underlying duration. The animation applies this property when: - Playback progresses toward, but hasn't yet reached, a nonzero ``AnimationDefinition/offset``. - A range determined by ``AnimationDefinition/trimStart``, ``AnimationDefinition/trimEnd``, or ``AnimationDefinition/trimDuration`` exceeds the animation's underlying duration.
trimStart
TypeScriptget trimStart(): (number) | nullvar trimStart: TimeInterval? { get set }The optional time, in seconds, at which the animation plays. This property is `nil` by default, which plays the animation from the starting frame defined by ``SampledAnimation/start``. If you set a value for this property, the animation visually begins from an additional seconds offset from the starting frame and decreases the duration by that amount. If you set a negative value for this property, the duration increases and the additional animation data fills in based on the ``SampledAnimation/fillMode`` you choose.
trimStart
TypeScriptset trimStart(value: (number) | null)var trimStart: TimeInterval? { get set }The optional time, in seconds, at which the animation plays. This property is `nil` by default, which plays the animation from the starting frame defined by ``SampledAnimation/start``. If you set a value for this property, the animation visually begins from an additional seconds offset from the starting frame and decreases the duration by that amount. If you set a negative value for this property, the duration increases and the additional animation data fills in based on the ``SampledAnimation/fillMode`` you choose.
tweenMode
TypeScriptget tweenMode(): TweenModevar tweenMode: TweenMode { get set }An option that determines how animation frames transition.
tweenMode
TypeScriptset tweenMode(value: TweenMode)var tweenMode: TweenMode { get set }An option that determines how animation frames transition.
processAndCreateAnimation
TypeScriptprocessAndCreateAnimationRetargetingOperationsName(config: RetargetingConfiguration, operations?: Array<SampledAnimation_SkeletalAnimationOperation<JointTransforms>>, name?: string): SDKHandlefunc processAndCreateAnimation(retargeting config: RetargetingConfiguration, operations: [SampledAnimation<Value>.SkeletalAnimationOperation] = [], name: String = "") throws -> any AnimationDefinitionProcesses skeletal animation with the specified retargeting and operations. Retargets the instance animation using the provided retargeting configuration and applies a series of skeletal animation processing operations to create a new animation definition. The function executes operations in the order specified. - Parameters: - config: The skeletal retargeting configuration to use. - operations: Operations to perform on the animation. If empty, only retargeting is performed. - name: Name for the processed animation. - Returns: An ``AnimationDefinition`` containing the processed animation. If root motion extraction is performed, returns an ``AnimationGroup`` containing both the skeletal animation (`SampledAnimation<JointTransforms>`) and extracted root motion (`SampledAnimation<Transform>`). Otherwise returns a `SampledAnimation<JointTransforms>`. - Throws: An error if validation fails. All errors provide descriptive messages via their `localizedDescription` property. Common validation failures include: - Duplicate operation types in a single call (e.g., two ``SkeletalAnimationOperation/extractRootMotion(jointName:options:lockPosition:)`` operations). - Both ``SkeletalAnimationOperation/extractRootMotion(jointName:options:lockPosition:)`` and ``SkeletalAnimationOperation/removeAnimation(for:)`` operations in the same call. - Operations requiring a skeleton when skeleton parameter is nil. - Joint name does not exist in the skeleton for root motion extraction or removal. - Base animation has a different sample rate than the source animation for ``SkeletalAnimationOperation/convertToAdditive(baseAnimation:)``.
processAndCreateAnimation
TypeScriptprocessAndCreateAnimationForOperationsName(skeleton: (SkeletonResource) | null, operations: Array<SampledAnimation_SkeletalAnimationOperation<JointTransforms>>, name?: string): SDKHandlefunc processAndCreateAnimation(for skeleton: SkeletonResource? = nil, operations: [SampledAnimation<Value>.SkeletalAnimationOperation], name: String = "") throws -> any AnimationDefinitionProcesses skeletal animation with the specified operations. Applies a series of skeletal animation processing operations to create a new animation. The function executes operations in the order specified. If skeleton is nil, only additive operations are supported. - Parameters: - skeleton: The skeleton resource for the animation; required for all operations except ``SkeletalAnimationOperation/convertToAdditive(baseAnimation:)`` and ``SkeletalAnimationOperation/convertToAdditiveUsingFirstSample()``. - operations: Operations to perform on the animation. Must not be empty. - name: Name for the processed animation. - Returns: An ``AnimationDefinition`` containing the processed animation. If root motion extraction is performed, returns an ``AnimationGroup`` containing both the skeletal animation (`SampledAnimation<JointTransforms>`) and extracted root motion (`SampledAnimation<Transform>`). Otherwise returns a `SampledAnimation<JointTransforms>`. - Throws: An error if validation fails. All errors provide descriptive messages via their `localizedDescription` property. Common validation failures include: - Duplicate operation types in a single call (e.g., two ``SkeletalAnimationOperation/extractRootMotion(jointName:options:lockPosition:)`` operations). - Both ``SkeletalAnimationOperation/extractRootMotion(jointName:options:lockPosition:)`` and ``SkeletalAnimationOperation/removeAnimation(for:)`` operations in the same call. - Operations requiring a skeleton when skeleton parameter is nil. - Joint name does not exist in the skeleton for root motion extraction or removal. - Base animation has a different sample rate than the source animation for ``SkeletalAnimationOperation/convertToAdditive(baseAnimation:)``.
removeAnimation
TypeScriptstatic removeAnimation(jointName: string): SampledAnimation_SkeletalAnimationOperation<JointTransforms>static func removeAnimation(for jointName: String) -> SampledAnimation<Value>.SkeletalAnimationOperationRemoves animation for the specified joint. - Parameter jointName: Name of the joint to remove animation from. - Returns: A ``SkeletalAnimationOperation`` that, when processed, produces a `SampledAnimation<JointTransforms>` with animation removed.
extractAll
TypeScriptget extractAll(): SampledAnimation_SkeletalAnimationOperation_RootMotionOptions<JointTransforms>static let extractAll: SampledAnimation<JointTransforms>.SkeletalAnimationOperation.RootMotionOptionsAll motion is extracted and returned.
translationX
TypeScriptget translationX(): SampledAnimation_SkeletalAnimationOperation_RootMotionOptions<JointTransforms>static let translationX: SampledAnimation<JointTransforms>.SkeletalAnimationOperation.RootMotionOptionsTranslation X is extracted.
translationY
TypeScriptget translationY(): SampledAnimation_SkeletalAnimationOperation_RootMotionOptions<JointTransforms>static let translationY: SampledAnimation<JointTransforms>.SkeletalAnimationOperation.RootMotionOptionsTranslation Y is extracted.
translationZ
TypeScriptget translationZ(): SampledAnimation_SkeletalAnimationOperation_RootMotionOptions<JointTransforms>static let translationZ: SampledAnimation<JointTransforms>.SkeletalAnimationOperation.RootMotionOptionsTranslation Z is extracted.
translationXZ
TypeScriptget translationXZ(): SampledAnimation_SkeletalAnimationOperation_RootMotionOptions<JointTransforms>static let translationXZ: SampledAnimation<JointTransforms>.SkeletalAnimationOperation.RootMotionOptionsTranslation XZ is extracted (common for ground-based locomotion).
init
TypeScriptinit(rawValue: number): SampledAnimation_SkeletalAnimationOperation_RootMotionOptions<JointTransforms>init(rawValue: UInt16)Creates a new option set from the given raw value. This initializer always succeeds, even if the value passed as `rawValue` exceeds the static properties declared as part of the option set. This example creates an instance of `ShippingOptions` with a raw value beyond the highest element, with a bit mask that effectively contains all the declared static members. let extraOptions = ShippingOptions(rawValue: 255) print(extraOptions.isStrictSuperset(of: .all)) // Prints "true" - Parameter rawValue: The raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
rawValue
TypeScriptgetRawValue($self: SampledAnimation_SkeletalAnimationOperation_RootMotionOptions): numberlet rawValue: UInt16The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"
rotationX
TypeScriptget rotationX(): SampledAnimation_SkeletalAnimationOperation_RootMotionOptions<JointTransforms>static let rotationX: SampledAnimation<JointTransforms>.SkeletalAnimationOperation.RootMotionOptionsRotation X is extracted.
rotationY
TypeScriptget rotationY(): SampledAnimation_SkeletalAnimationOperation_RootMotionOptions<JointTransforms>static let rotationY: SampledAnimation<JointTransforms>.SkeletalAnimationOperation.RootMotionOptionsRotation Y is extracted.
rotationZ
TypeScriptget rotationZ(): SampledAnimation_SkeletalAnimationOperation_RootMotionOptions<JointTransforms>static let rotationZ: SampledAnimation<JointTransforms>.SkeletalAnimationOperation.RootMotionOptionsRotation Z is extracted.
convertToAdditive
TypeScriptstatic convertToAdditive(baseAnimation: AnimationResource): SampledAnimation_SkeletalAnimationOperation<JointTransforms>static func convertToAdditive(baseAnimation: AnimationResource) -> SampledAnimation<Value>.SkeletalAnimationOperationConverts animation to additive format by subtracting a base animation. Creates a delta animation that represents the difference between this animation and the provided base animation. You can layer the resulting animation on top of other animations using additive blending. If the base animation has more samples than the target animation, the function subtracts the last sample from each remaining sample in the target. The function throws an error if the base and target animations do not have the same frame interval (sample rate). - Parameter baseAnimation: Base animation to subtract. - Returns: A ``SkeletalAnimationOperation`` that, when processed, produces a `SampledAnimation<JointTransforms>` in additive format.
extractRootMotion
TypeScriptstatic extractRootMotion(jointName: string, options?: SampledAnimation_SkeletalAnimationOperation_RootMotionOptions<JointTransforms>, lockPosition?: (Transform) | null): SampledAnimation_SkeletalAnimationOperation<JointTransforms>static func extractRootMotion(jointName: String, options: SampledAnimation<Value>.SkeletalAnimationOperation.RootMotionOptions = .translationXZ, lockPosition: Transform? = nil) -> SampledAnimation<Value>.SkeletalAnimationOperationExtracts root motion from the specified joint. Removes the specified transform components from the joint and returns them as a separate `SampledAnimation<Transform>` in the resulting ``AnimationGroup``. The skeletal animation will have the extracted motion removed. The returned `SampledAnimation<Transform>` has ``SampledAnimation/bindTarget`` set to ``BindTarget/rootMotion`` automatically — playing the group drives the entity's root motion and emits ``AnimationEvents/RootMotionDidUpdate`` events. - Parameters: - jointName: Name of the joint to extract root motion from. - options: Transform components to extract. - lockPosition: Position to lock the root joint to after extraction. - Returns: A ``SkeletalAnimationOperation`` that, when processed, produces an ``AnimationGroup`` containing both the modified skeletal animation and the extracted transform sampled animation used for root motion. When you extract root motion, the function returns an ``AnimationGroup`` containing both the skeletal animation and the root motion animation. Playing back this group triggers root motion events in sync with the skeletal animation. The event callback receives the delta transform moved between the last frame and the current frame. If no event handler subscribes to the root motion on the target entity, the system automatically applies the delta to the entity's transform.
convertToAdditiveUsingRestPose
TypeScriptstatic convertToAdditiveUsingRestPose(): SampledAnimation_SkeletalAnimationOperation<JointTransforms>static func convertToAdditiveUsingRestPose() -> SampledAnimation<Value>.SkeletalAnimationOperationConverts animation to additive format by subtracting the skeleton's rest pose. Creates a delta animation that represents the difference between this animation and the skeleton's rest pose. Requires a skeleton to be provided to ``SampledAnimation/processAndCreateAnimation(for:operations:name:)``. - Returns: A ``SkeletalAnimationOperation`` that, when processed, produces a `SampledAnimation<JointTransforms>` in additive format.
convertToAdditiveUsingFirstSample
TypeScriptstatic convertToAdditiveUsingFirstSample(): SampledAnimation_SkeletalAnimationOperation<JointTransforms>static func convertToAdditiveUsingFirstSample() -> SampledAnimation<Value>.SkeletalAnimationOperationConverts animation to additive format by subtracting the first frame. Creates a delta animation that represents the difference between each frame and the animation's first frame. Useful for creating relative motion from absolute animation. - Returns: A ``SkeletalAnimationOperation`` that, when processed, produces a `SampledAnimation<JointTransforms>` in additive format.
init
TypeScriptstatic initJointNamesFramesNameTweenModeFrameIntervalIsAdditiveIsScaleAnimatedIsRotationAnimatedIsTranslationAnimatedBindTargetBlendLayerRepeatModeFillModeTrimStartTrimEndTrimDurationOffsetDelaySpeed(jointNames: Array<string>, frames: Array<JointTransforms>, name?: string, tweenMode?: TweenMode, frameInterval?: number, isAdditive?: boolean, isScaleAnimated?: boolean, isRotationAnimated?: boolean, isTranslationAnimated?: boolean, bindTarget?: (BindTarget) | null, blendLayer?: number, repeatMode?: AnimationRepeatMode, fillMode?: AnimationFillMode, trimStart?: (number) | null, trimEnd?: (number) | null, trimDuration?: (number) | null, offset?: number, delay?: number, speed?: number): SampledAnimation<JointTransforms>init(jointNames: [String], frames: [Value], name: String = "", tweenMode: TweenMode = .linear, frameInterval: Float = 1.0 / 30.0, isAdditive: Bool = false, isScaleAnimated: Bool = true, isRotationAnimated: Bool = true, isTranslationAnimated: Bool = true, bindTarget: BindTarget? = nil, blendLayer: Int32 = 0, repeatMode: AnimationRepeatMode = .none, fillMode: AnimationFillMode = [], trimStart: TimeInterval? = nil, trimEnd: TimeInterval? = nil, trimDuration: TimeInterval? = nil, offset: TimeInterval = 0, delay: TimeInterval = 0, speed: Float = 1.0)Creates an animation that interpolates between two configurations of the given joints. - Parameters: - jointNames: The names of the joints to animate. - frames: The value of the joints to animate. - name: A textual name for the animation. - tweenMode: An option that determines how animation frames transition. - frameInterval: The duration within the animation timeline for each frame in the frames array. - isAdditive: A Boolean value that indicates whether the animation builds on the current state of the target entity or resets the state before running. - isScaleAnimated: A Boolean value that indicates whether the animation observes changes in the entity’s size. - isRotationAnimated: A Boolean value that indicates whether the animation observes rotational changes in the entity’s transform. - isTranslationAnimated: A Boolean value that indicates whether the animation observes translational changes in the entity’s transform. - bindTarget: A textual name that identifies the particular property that animates. - blendLayer: The order in which the framework composites the animation into the view. - repeatMode: An option that determines how the animation repeats. - fillMode: The playback behavior outside of the normal duration. - trimStart: The optional time, in seconds, at which the animation plays. - trimEnd: The optional time, in seconds, at which the animation stops. - trimDuration: An optional duration that overrides the calculated duration. - offset: The time, in seconds, at which the animation begins within the duration. - delay: An amount of time that elapses before the animation plays. - speed: A factor that changes the animation’s rate of playback.
jointNames
TypeScriptget jointNames(): Array<string>var jointNames: [String] { get set }The names of the joints to animate.
jointNames
TypeScriptset jointNames(value: Array<string>)var jointNames: [String] { get set }The names of the joints to animate.
isScaleAnimated
TypeScriptget isScaleAnimated(): booleanvar isScaleAnimated: Bool { get set }A Boolean value that indicates whether the animation observes changes in the entity’s size. If you set this property to `true`, the animation accommodates scale differences in the entity’s transform by interpolating to the target scale across the animation timeline.
isScaleAnimated
TypeScriptset isScaleAnimated(value: boolean)var isScaleAnimated: Bool { get set }A Boolean value that indicates whether the animation observes changes in the entity’s size. If you set this property to `true`, the animation accommodates scale differences in the entity’s transform by interpolating to the target scale across the animation timeline.
isRotationAnimated
TypeScriptget isRotationAnimated(): booleanvar isRotationAnimated: Bool { get set }A Boolean value that indicates whether the animation observes rotational changes in the entity’s transform. If you set this property to `true`, the animation accommodates rotational differences in the entity's transform by interpolating to the target rotation across the animation timeline.
isRotationAnimated
TypeScriptset isRotationAnimated(value: boolean)var isRotationAnimated: Bool { get set }A Boolean value that indicates whether the animation observes rotational changes in the entity’s transform. If you set this property to `true`, the animation accommodates rotational differences in the entity's transform by interpolating to the target rotation across the animation timeline.
isTranslationAnimated
TypeScriptget isTranslationAnimated(): booleanvar isTranslationAnimated: Bool { get set }A Boolean value that indicates whether the animation observes translational changes in the entity's transform. If you set this property to `true`, the animation accommodates translation differences in the entity’s transform by interpolating to the target translation across the animation timeline.
isTranslationAnimated
TypeScriptset isTranslationAnimated(value: boolean)var isTranslationAnimated: Bool { get set }A Boolean value that indicates whether the animation observes translational changes in the entity's transform. If you set this property to `true`, the animation accommodates translation differences in the entity’s transform by interpolating to the target translation across the animation timeline.
frames
TypeScriptget frames(): Array<JointTransforms>var frames: [JointTransforms] { get set }An array of joint transforms in which each element represents a discrete state of the target entity at a given point in the animation's timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of joint transforms.
frames
TypeScriptset frames(value: Array<JointTransforms>)var frames: [JointTransforms] { get set }An array of joint transforms in which each element represents a discrete state of the target entity at a given point in the animation's timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of joint transforms.
init
TypeScriptstatic initWeightNamesFramesNameTweenModeFrameIntervalIsAdditiveBindTargetBlendLayerRepeatModeFillModeTrimStartTrimEndTrimDurationOffsetDelaySpeed(weightNames: Array<string>, frames: Array<BlendShapeWeights>, name?: string, tweenMode?: TweenMode, frameInterval?: number, isAdditive?: boolean, bindTarget?: (BindTarget) | null, blendLayer?: number, repeatMode?: AnimationRepeatMode, fillMode?: AnimationFillMode, trimStart?: (number) | null, trimEnd?: (number) | null, trimDuration?: (number) | null, offset?: number, delay?: number, speed?: number): SampledAnimation<BlendShapeWeights>init(weightNames: [String], frames: [Value], name: String = "", tweenMode: TweenMode = .linear, frameInterval: Float = 1.0 / 30.0, isAdditive: Bool = false, bindTarget: BindTarget? = nil, blendLayer: Int32 = 0, repeatMode: AnimationRepeatMode = .none, fillMode: AnimationFillMode = [], trimStart: TimeInterval? = nil, trimEnd: TimeInterval? = nil, trimDuration: TimeInterval? = nil, offset: TimeInterval = 0, delay: TimeInterval = 0, speed: Float = 1.0)Creates an animation that blends between a configuration of blend targets. - Parameters: - weightNames: The names of the weights in the animated blend shape. - frames: The value of the weights to animate. - name: A textual name for the animation. - tweenMode: An option that determines how animation frames transition. - frameInterval: The duration within the animation timeline for each frame in the frames array. - isAdditive: A Boolean value that indicates whether the animation builds on the current state of the target entity or resets the state before running. - bindTarget: A textual name that identifies the particular property that animates. - blendLayer: The order in which the framework composites the animation into the view. - repeatMode: An option that determines how the animation repeats. - fillMode: The playback behavior outside of the normal duration. - trimStart: The optional time, in seconds, at which the animation plays. - trimEnd: The optional time, in seconds, at which the animation stops. - trimDuration: An optional duration that overrides the calculated duration. - offset: The time, in seconds, at which the animation begins within the duration. - delay: An amount of time that elapses before the animation plays. - speed: A factor that changes the animation’s rate of playback.
weightNames
TypeScriptget weightNames(): Array<string>var weightNames: [String] { get set }The names of the weights to animate.
weightNames
TypeScriptset weightNames(value: Array<string>)var weightNames: [String] { get set }The names of the weights to animate.
frames
TypeScriptget frames61181(): Array<BlendShapeWeights>var frames: [BlendShapeWeights] { get set }An array of weights in which each element represents a discrete state of the target entity at a given point in the animation's timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of weights.
frames
TypeScriptset frames61181(value: Array<BlendShapeWeights>)var frames: [BlendShapeWeights] { get set }An array of weights in which each element represents a discrete state of the target entity at a given point in the animation's timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of weights.
frames
TypeScriptget frames70201(): Array<Transform>var frames: [Transform] { get set }An array of transforms in which each element represents a discrete state of the target entity at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of tranforms.
frames
TypeScriptset frames70201(value: Array<Transform>)var frames: [Transform] { get set }An array of transforms in which each element represents a discrete state of the target entity at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of tranforms.
frames
TypeScriptget frames44380(): Array<number>var frames: [Double] { get set }An array of double-precision values in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of `Double` values.
frames
TypeScriptset frames44380(value: Array<number>)var frames: [Double] { get set }An array of double-precision values in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of `Double` values.
frames
TypeScriptget frames30348(): Array<number>var frames: [Float] { get set }An array of floating-point values in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of `Float` values.
frames
TypeScriptset frames30348(value: Array<number>)var frames: [Float] { get set }An array of floating-point values in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of `Float` values.
frames
TypeScriptget frames8233(): Array<SDKHandle>var frames: [simd_quatf] { get set }An array of quaternions in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of quaternions.
frames
TypeScriptset frames8233(value: Array<SDKHandle>)var frames: [simd_quatf] { get set }An array of quaternions in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of quaternions.
frames
TypeScriptget frames54439(): Array<SDKHandle>var frames: [SIMD2<Float>] { get set }An array of floating-point pairs in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of <doc://com.apple.documentation/documentation/accelerate/simd> floating-point pairs.
frames
TypeScriptset frames54439(value: Array<SDKHandle>)var frames: [SIMD2<Float>] { get set }An array of floating-point pairs in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of <doc://com.apple.documentation/documentation/accelerate/simd> floating-point pairs.
frames
TypeScriptget frames35752(): Array<SDKHandle>var frames: [SIMD3<Float>] { get set }An array of floating-point triplets in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of <doc://com.apple.documentation/documentation/accelerate/simd> floating-point triplets.
frames
TypeScriptset frames35752(value: Array<SDKHandle>)var frames: [SIMD3<Float>] { get set }An array of floating-point triplets in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of <doc://com.apple.documentation/documentation/accelerate/simd> floating-point triplets.
frames
TypeScriptget frames50169(): Array<SDKHandle>var frames: [SIMD4<Float>] { get set }An array of floating-point quadruples in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of <doc://com.apple.documentation/documentation/accelerate/simd> floating-point quadruplets.
frames
TypeScriptset frames50169(value: Array<SDKHandle>)var frames: [SIMD4<Float>] { get set }An array of floating-point quadruples in which each element represents a discrete state of the animated property at a given point in the animation’s timeline. This array contains sequential values for the animated property when ``AnimationDefinition/bindTarget`` is an array of <doc://com.apple.documentation/documentation/accelerate/simd> floating-point quadruplets.
bindTarget
TypeScriptget bindTarget(): BindTargetvar bindTarget: BindTarget { get set }A textual name that identifies the particular property that animates. The property name is a key path. For more information on key paths, see <doc://com.apple.documentation/documentation/swift/swift_standard_library/key-path_expressions>.
bindTarget
TypeScriptset bindTarget(value: BindTarget)var bindTarget: BindTarget { get set }A textual name that identifies the particular property that animates. The property name is a key path. For more information on key paths, see <doc://com.apple.documentation/documentation/swift/swift_standard_library/key-path_expressions>.
blendLayer
TypeScriptget blendLayer(): numbervar blendLayer: Int32 { get set }The order in which the framework composites the animation. The framework applies multiple animations on the same target in ascending order of this property’s value. Animations in a lower layer run before animations in a higher layer. Animations that share the same value apply in the order that they execute.
blendLayer
TypeScriptset blendLayer(value: number)var blendLayer: Int32 { get set }The order in which the framework composites the animation. The framework applies multiple animations on the same target in ascending order of this property’s value. Animations in a lower layer run before animations in a higher layer. Animations that share the same value apply in the order that they execute.
isAdditive
TypeScriptget isAdditive(): booleanvar isAdditive: Bool { get set }A Boolean value that indicates whether the animation blends additively with concurrent animations.
isAdditive
TypeScriptset isAdditive(value: boolean)var isAdditive: Bool { get set }A Boolean value that indicates whether the animation blends additively with concurrent animations.
repeatMode
TypeScriptget repeatMode(): AnimationRepeatModevar repeatMode: AnimationRepeatMode { get set }An option that determines how the animation repeats. If you call ``FromToByAnimation/trimmed(start:end:duration:)`` with a `start` or `end` that lies outside of the timeline defined by ``FromToByAnimation/duration``, the animation fills the additional playback by applying this property.
repeatMode
TypeScriptset repeatMode(value: AnimationRepeatMode)var repeatMode: AnimationRepeatMode { get set }An option that determines how the animation repeats. If you call ``FromToByAnimation/trimmed(start:end:duration:)`` with a `start` or `end` that lies outside of the timeline defined by ``FromToByAnimation/duration``, the animation fills the additional playback by applying this property.
trimDuration
TypeScriptget trimDuration(): (number) | nullvar trimDuration: TimeInterval? { get set }An optional duration that overrides the calculated duration. The framework calculates ``FromToByAnimation/duration``, but you can set this property to override it. This property is `nil` by default, which indicates that the animation stops after one play that spans ``FromToByAnimation/duration``. If you set a non-zero value for this property and both ``FromToByAnimation/trimStart`` and ``FromToByAnimation/trimEnd`` are `nil`, the animation observes this property as an edited duration. When you set ``FromToByAnimation/repeatMode`` to make the animation repeat: - If this property is `nil`, the animation repeats forever. - If set to a value greater than ``FromToByAnimation/duration``, the animation repeats for the specified duration.
trimDuration
TypeScriptset trimDuration(value: (number) | null)var trimDuration: TimeInterval? { get set }An optional duration that overrides the calculated duration. The framework calculates ``FromToByAnimation/duration``, but you can set this property to override it. This property is `nil` by default, which indicates that the animation stops after one play that spans ``FromToByAnimation/duration``. If you set a non-zero value for this property and both ``FromToByAnimation/trimStart`` and ``FromToByAnimation/trimEnd`` are `nil`, the animation observes this property as an edited duration. When you set ``FromToByAnimation/repeatMode`` to make the animation repeat: - If this property is `nil`, the animation repeats forever. - If set to a value greater than ``FromToByAnimation/duration``, the animation repeats for the specified duration.
init
TypeScriptstatic initNameFromToByDurationTimingIsAdditiveBindTargetBlendLayerRepeatModeFillModeTrimStartTrimEndTrimDurationOffsetDelaySpeed(name?: string, from?: (number) | null, to?: (number) | null, by?: (number) | null, duration?: number, timing?: AnimationTimingFunction, isAdditive?: boolean, bindTarget?: (BindTarget) | null, blendLayer?: number, repeatMode?: AnimationRepeatMode, fillMode?: AnimationFillMode, trimStart?: (number) | null, trimEnd?: (number) | null, trimDuration?: (number) | null, offset?: number, delay?: number, speed?: number): FromToByAnimation<number>init(name: String = "", from: Value? = nil, to: Value? = nil, by: Value? = nil, duration: TimeInterval = 1.0, timing: AnimationTimingFunction = .linear, isAdditive: Bool = false, bindTarget: BindTarget? = nil, blendLayer: Int32 = 0, repeatMode: AnimationRepeatMode = .none, fillMode: AnimationFillMode = [], trimStart: TimeInterval? = nil, trimEnd: TimeInterval? = nil, trimDuration: TimeInterval? = nil, offset: TimeInterval = 0, delay: TimeInterval = 0, speed: Float = 1.0)Creates an animation that interpolates between two values for a property of the target entity. - Parameters: - name: A unique name for the animation. - from: The state of the animated property before the animation starts. - to: The state of the animated property after the animation ends. - by: An amount that increments the animated property during the animation. - duration: The total playback time. - timing: An option that determines the animation’s pace over time. - isAdditive: A Boolean value that indicates whether the animation blends additively with concurrent animations. - bindTarget: A textual name that identifies the particular property that animates. - blendLayer: The order in which the framework composites the animation into the view. - repeatMode: An option that determines how the animation repeats. - fillMode: The playback behavior outside of the normal duration. - trimStart: The time, in seconds, at which the animation plays. - trimEnd: The time, in seconds, at which the animation stops. - trimDuration: An optional duration that overrides the calculated duration. - offset: The time, in seconds, at which the animation begins within the duration. - delay: An amount of time that elapses before the animation plays. - speed: A factor that increases or decreases the animation’s rate of playback.
name
TypeScriptget name(): stringvar name: String { get set }A textual name for the animation.
name
TypeScriptset name(value: string)var name: String { get set }A textual name for the animation.
delay
TypeScriptget delay(): numbervar delay: TimeInterval { get set }An amount of time that elapses before the animation plays. The default value is `0`, which indicates that the animation plays with no delay. If you set a value for this property, the animation plays from its start time after the specified delay lapses. During the delayed time, the animation doesn't update. However, to fill the delayed time with some portion of animation, set a negative ``FromToByAnimation/trimStart`` instead and choose a ``FromToByAnimation/fillMode`` that displays the desired portion of animation.
delay
TypeScriptset delay(value: number)var delay: TimeInterval { get set }An amount of time that elapses before the animation plays. The default value is `0`, which indicates that the animation plays with no delay. If you set a value for this property, the animation plays from its start time after the specified delay lapses. During the delayed time, the animation doesn't update. However, to fill the delayed time with some portion of animation, set a negative ``FromToByAnimation/trimStart`` instead and choose a ``FromToByAnimation/fillMode`` that displays the desired portion of animation.
speed
TypeScriptget speed(): numbervar speed: Float { get set }A factor that increases or decreases the animation’s rate of playback. The default value is `1.0`, which doesn’t alter the animation’s duration. A value of `2.0` indicates that the duration is half the normal rate. A value of `0.5` indicates that the duration is twice the normal rate. Negative values play the animation in reverse. This property doesn’t affect the animation’s ``FromToByAnimation/delay``.
speed
TypeScriptset speed(value: number)var speed: Float { get set }A factor that increases or decreases the animation’s rate of playback. The default value is `1.0`, which doesn’t alter the animation’s duration. A value of `2.0` indicates that the duration is half the normal rate. A value of `0.5` indicates that the duration is twice the normal rate. Negative values play the animation in reverse. This property doesn’t affect the animation’s ``FromToByAnimation/delay``.
offset
TypeScriptget offset(): numbervar offset: TimeInterval { get set }The time, in seconds, at which the animation begins within the duration. The default value is `0`, which indicates that the animation plays with no offset. If you set a value for this property, the animation plays immediately, beginning at the specified time.
offset
TypeScriptset offset(value: number)var offset: TimeInterval { get set }The time, in seconds, at which the animation begins within the duration. The default value is `0`, which indicates that the animation plays with no offset. If you set a value for this property, the animation plays immediately, beginning at the specified time.
timing
TypeScriptget timing(): AnimationTimingFunctionvar timing: AnimationTimingFunction { get set }An option that determines the animation’s pace over time. Depending on the option you pick, the animation's progress moves at varying speeds along its duration.
timing
TypeScriptset timing(value: AnimationTimingFunction)var timing: AnimationTimingFunction { get set }An option that determines the animation’s pace over time. Depending on the option you pick, the animation's progress moves at varying speeds along its duration.
trimEnd
TypeScriptget trimEnd(): (number) | nullvar trimEnd: TimeInterval? { get set }The time, in seconds, at which the animation stops. This property is `nil` by default, which plays the animation until `time` = ``FromToByAnimation/duration``. If you set a value, the animation edits the duration according to the specified ending time.
trimEnd
TypeScriptset trimEnd(value: (number) | null)var trimEnd: TimeInterval? { get set }The time, in seconds, at which the animation stops. This property is `nil` by default, which plays the animation until `time` = ``FromToByAnimation/duration``. If you set a value, the animation edits the duration according to the specified ending time.
duration
TypeScriptget duration(): numbervar duration: TimeInterval { get set }The total playback time of the animation. The framework sets a value for this property depending on the underlying animation data and the specified ``AnimationView/speed``. You can override the default duration by defining ``FromToByAnimation/trimStart``, ``FromToByAnimation/trimEnd``, or ``FromToByAnimation/trimDuration``.
duration
TypeScriptset duration(value: number)var duration: TimeInterval { get set }The total playback time of the animation. The framework sets a value for this property depending on the underlying animation data and the specified ``AnimationView/speed``. You can override the default duration by defining ``FromToByAnimation/trimStart``, ``FromToByAnimation/trimEnd``, or ``FromToByAnimation/trimDuration``.
fillMode
TypeScriptget fillMode(): AnimationFillModevar fillMode: AnimationFillMode { get set }An option that determines which data displays outside of the normal duration. This property determines what to display when the framework samples the animation outside of the range defined by its underlying duration. The animation applies this property when: - Playback progresses toward, but hasn't yet reached, a nonzero ``AnimationDefinition/offset``. - A range determined by ``AnimationDefinition/trimStart``, ``AnimationDefinition/trimEnd``, or ``AnimationDefinition/trimDuration`` exceeds the animation's underlying duration.
fillMode
TypeScriptset fillMode(value: AnimationFillMode)var fillMode: AnimationFillMode { get set }An option that determines which data displays outside of the normal duration. This property determines what to display when the framework samples the animation outside of the range defined by its underlying duration. The animation applies this property when: - Playback progresses toward, but hasn't yet reached, a nonzero ``AnimationDefinition/offset``. - A range determined by ``AnimationDefinition/trimStart``, ``AnimationDefinition/trimEnd``, or ``AnimationDefinition/trimDuration`` exceeds the animation's underlying duration.
trimStart
TypeScriptget trimStart(): (number) | nullvar trimStart: TimeInterval? { get set }The time, in seconds, at which the animation plays. This property is `nil` by default, which plays the animation with `time` = `0`. If you set a value, the animation edits the duration according to the specified beginning time. If you set a negative value for this property, the duration increases and the additional animation data fills in based on the ``FromToByAnimation/fillMode`` you choose.
trimStart
TypeScriptset trimStart(value: (number) | null)var trimStart: TimeInterval? { get set }The time, in seconds, at which the animation plays. This property is `nil` by default, which plays the animation with `time` = `0`. If you set a value, the animation edits the duration according to the specified beginning time. If you set a negative value for this property, the duration increases and the additional animation data fills in based on the ``FromToByAnimation/fillMode`` you choose.
init
TypeScriptstatic initJointNamesNameIsScaleAnimatedIsRotationAnimatedIsTranslationAnimatedFromToByDurationTimingIsAdditiveBindTargetBlendLayerRepeatModeFillModeTrimStartTrimEndTrimDurationOffsetDelaySpeed(jointNames: Array<string>, name?: string, isScaleAnimated?: boolean, isRotationAnimated?: boolean, isTranslationAnimated?: boolean, from?: (JointTransforms) | null, to?: (JointTransforms) | null, by?: (JointTransforms) | null, duration?: number, timing?: AnimationTimingFunction, isAdditive?: boolean, bindTarget?: (BindTarget) | null, blendLayer?: number, repeatMode?: AnimationRepeatMode, fillMode?: AnimationFillMode, trimStart?: (number) | null, trimEnd?: (number) | null, trimDuration?: (number) | null, offset?: number, delay?: number, speed?: number): FromToByAnimation<JointTransforms>init(jointNames: [String], name: String = "", isScaleAnimated: Bool = true, isRotationAnimated: Bool = true, isTranslationAnimated: Bool = true, from: Value? = nil, to: Value? = nil, by: Value? = nil, duration: TimeInterval = 1.0, timing: AnimationTimingFunction = .linear, isAdditive: Bool = false, bindTarget: BindTarget? = nil, blendLayer: Int32 = 0, repeatMode: AnimationRepeatMode = .none, fillMode: AnimationFillMode = [], trimStart: TimeInterval? = nil, trimEnd: TimeInterval? = nil, trimDuration: TimeInterval? = nil, offset: TimeInterval = 0, delay: TimeInterval = 0, speed: Float = 1.0)Creates an animation that interpolates between two configurations of the given joints. - Parameters: - jointNames: The names of the joints in the animated skeletal pose. - name: A unique name for the animation. - isScaleAnimated: A Boolean value that indicates whether that animation interpolates changes to the target’s size. - isRotationAnimated: A Boolean value that indicates whether that animation interpolates rotational changes. - isTranslationAnimated: A Boolean value that indicates whether that animation interpolates changes to the target object’s position. - from: The state of the target object’s joints before the animation starts. - to: The state of the target object’s joints after the animation finishes. - by: An amount that increments the animated joints during the animation. - duration: The total playback time. - timing: An option that determines the animation’s pace over time. - isAdditive: A Boolean value that indicates whether the animation blends additively with concurrent animations. - bindTarget: A textual name that identifies the particular property that animates. - blendLayer: The order in which the framework composites the animation into the view. - repeatMode: An option that determines how the animation repeats. - fillMode: The playback behavior outside of the normal duration. - trimStart: The optional time, in seconds, at which the animation plays. - trimEnd: The optional time, in seconds, at which the animation stops. - trimDuration: An optional duration that overrides the calculated duration. - offset: The time, in seconds, at which the animation begins within the duration. - delay: An amount of time that elapses before the animation plays. - speed: A factor that increases or decreases the animation’s rate of playback.
jointNames
TypeScriptget jointNames(): Array<string>var jointNames: [String] { get set }Joint names that define the joints in the skeletal pose.
jointNames
TypeScriptset jointNames(value: Array<string>)var jointNames: [String] { get set }Joint names that define the joints in the skeletal pose.
isScaleAnimated
TypeScriptget isScaleAnimated(): booleanvar isScaleAnimated: Bool { get set }A Boolean value that indicates whether that animation interpolates changes to the target’s size.
isScaleAnimated
TypeScriptset isScaleAnimated(value: boolean)var isScaleAnimated: Bool { get set }A Boolean value that indicates whether that animation interpolates changes to the target’s size.
isRotationAnimated
TypeScriptget isRotationAnimated(): booleanvar isRotationAnimated: Bool { get set }A Boolean value that indicates whether the animation interpolates rotational changes.
isRotationAnimated
TypeScriptset isRotationAnimated(value: boolean)var isRotationAnimated: Bool { get set }A Boolean value that indicates whether the animation interpolates rotational changes.
isTranslationAnimated
TypeScriptget isTranslationAnimated(): booleanvar isTranslationAnimated: Bool { get set }A Boolean value that indicates whether the animation interpolates changes to the target object’s position.
isTranslationAnimated
TypeScriptset isTranslationAnimated(value: boolean)var isTranslationAnimated: Bool { get set }A Boolean value that indicates whether the animation interpolates changes to the target object’s position.
byValue
TypeScriptget byValue(): (JointTransforms) | nullvar byValue: JointTransforms? { get set }byValue
TypeScriptset byValue(value: (JointTransforms) | null)var byValue: JointTransforms? { get set }toValue
TypeScriptget toValue(): (JointTransforms) | nullvar toValue: JointTransforms? { get set }toValue
TypeScriptset toValue(value: (JointTransforms) | null)var toValue: JointTransforms? { get set }fromValue
TypeScriptget fromValue(): (JointTransforms) | nullvar fromValue: JointTransforms? { get set }fromValue
TypeScriptset fromValue(value: (JointTransforms) | null)var fromValue: JointTransforms? { get set }init
TypeScriptstatic initWeightNamesNameFromToByDurationTimingIsAdditiveBindTargetBlendLayerRepeatModeFillModeTrimStartTrimEndTrimDurationOffsetDelaySpeed(weightNames: Array<string>, name?: string, from?: (BlendShapeWeights) | null, to?: (BlendShapeWeights) | null, by?: (BlendShapeWeights) | null, duration?: number, timing?: AnimationTimingFunction, isAdditive?: boolean, bindTarget?: (BindTarget) | null, blendLayer?: number, repeatMode?: AnimationRepeatMode, fillMode?: AnimationFillMode, trimStart?: (number) | null, trimEnd?: (number) | null, trimDuration?: (number) | null, offset?: number, delay?: number, speed?: number): FromToByAnimation<BlendShapeWeights>init(weightNames: [String], name: String = "", from: Value? = nil, to: Value? = nil, by: Value? = nil, duration: TimeInterval = 1.0, timing: AnimationTimingFunction = .linear, isAdditive: Bool = false, bindTarget: BindTarget? = nil, blendLayer: Int32 = 0, repeatMode: AnimationRepeatMode = .none, fillMode: AnimationFillMode = [], trimStart: TimeInterval? = nil, trimEnd: TimeInterval? = nil, trimDuration: TimeInterval? = nil, offset: TimeInterval = 0, delay: TimeInterval = 0, speed: Float = 1.0)Creates an animation that blends between a configuration of blend targets. - Parameters: - weightNames: The names of the weights in the animated blend shape. - name: A unique name for the animation. - from: The state of the target object’s weights before the animation starts. - to: The state of the target object’s weights after the animation finishes. - by: An amount that increments the animated weights during the animation. - duration: The total playback time. - timing: An option that determines the animation’s pace over time. - isAdditive: A Boolean value that indicates whether the animation blends additively with concurrent animations. - bindTarget: A textual name that identifies the particular property that animates. - blendLayer: The order in which the framework composites the animation into the view. - repeatMode: An option that determines how the animation repeats. - fillMode: The playback behavior outside of the normal duration. - trimStart: The optional time, in seconds, at which the animation plays. - trimEnd: The optional time, in seconds, at which the animation stops. - trimDuration: An optional duration that overrides the calculated duration. - offset: The time, in seconds, at which the animation begins within the duration. - delay: An amount of time that elapses before the animation plays. - speed: A factor that increases or decreases the animation’s rate of playback.
weightNames
TypeScriptget weightNames(): Array<string>var weightNames: [String] { get set }Weight names that define the weights for the blend shape.
weightNames
TypeScriptset weightNames(value: Array<string>)var weightNames: [String] { get set }Weight names that define the weights for the blend shape.
byValue
TypeScriptget byValue36059(): (BlendShapeWeights) | nullvar byValue: BlendShapeWeights? { get set }byValue
TypeScriptset byValue36059(value: (BlendShapeWeights) | null)var byValue: BlendShapeWeights? { get set }toValue
TypeScriptget toValue30219(): (BlendShapeWeights) | nullvar toValue: BlendShapeWeights? { get set }toValue
TypeScriptset toValue30219(value: (BlendShapeWeights) | null)var toValue: BlendShapeWeights? { get set }fromValue
TypeScriptget fromValue62030(): (BlendShapeWeights) | nullvar fromValue: BlendShapeWeights? { get set }fromValue
TypeScriptset fromValue62030(value: (BlendShapeWeights) | null)var fromValue: BlendShapeWeights? { get set }byValue
TypeScriptget byValue50769(): (Transform) | nullvar byValue: Transform? { get set }byValue
TypeScriptset byValue50769(value: (Transform) | null)var byValue: Transform? { get set }toValue
TypeScriptget toValue60865(): (Transform) | nullvar toValue: Transform? { get set }toValue
TypeScriptset toValue60865(value: (Transform) | null)var toValue: Transform? { get set }fromValue
TypeScriptget fromValue52136(): (Transform) | nullvar fromValue: Transform? { get set }fromValue
TypeScriptset fromValue52136(value: (Transform) | null)var fromValue: Transform? { get set }byValue
TypeScriptget byValue91746(): (number) | nullvar byValue: Double? { get set }byValue
TypeScriptset byValue91746(value: (number) | null)var byValue: Double? { get set }toValue
TypeScriptget toValue18002(): (number) | nullvar toValue: Double? { get set }toValue
TypeScriptset toValue18002(value: (number) | null)var toValue: Double? { get set }fromValue
TypeScriptget fromValue94771(): (number) | nullvar fromValue: Double? { get set }fromValue
TypeScriptset fromValue94771(value: (number) | null)var fromValue: Double? { get set }byValue
TypeScriptget byValue32182(): (number) | nullvar byValue: Float? { get set }byValue
TypeScriptset byValue32182(value: (number) | null)var byValue: Float? { get set }toValue
TypeScriptget toValue42406(): (number) | nullvar toValue: Float? { get set }toValue
TypeScriptset toValue42406(value: (number) | null)var toValue: Float? { get set }fromValue
TypeScriptget fromValue65471(): (number) | nullvar fromValue: Float? { get set }fromValue
TypeScriptset fromValue65471(value: (number) | null)var fromValue: Float? { get set }byValue
TypeScriptget byValue19007(): (SDKHandle) | nullvar byValue: simd_quatf? { get set }byValue
TypeScriptset byValue19007(value: (SDKHandle) | null)var byValue: simd_quatf? { get set }toValue
TypeScriptget toValue84863(): (SDKHandle) | nullvar toValue: simd_quatf? { get set }toValue
TypeScriptset toValue84863(value: (SDKHandle) | null)var toValue: simd_quatf? { get set }fromValue
TypeScriptget fromValue29234(): (SDKHandle) | nullvar fromValue: simd_quatf? { get set }fromValue
TypeScriptset fromValue29234(value: (SDKHandle) | null)var fromValue: simd_quatf? { get set }byValue
TypeScriptget byValue46579(): (SDKHandle) | nullvar byValue: SIMD2<Float>? { get set }byValue
TypeScriptset byValue46579(value: (SDKHandle) | null)var byValue: SIMD2<Float>? { get set }toValue
TypeScriptget toValue97071(): (SDKHandle) | nullvar toValue: SIMD2<Float>? { get set }toValue
TypeScriptset toValue97071(value: (SDKHandle) | null)var toValue: SIMD2<Float>? { get set }fromValue
TypeScriptget fromValue63030(): (SDKHandle) | nullvar fromValue: SIMD2<Float>? { get set }fromValue
TypeScriptset fromValue63030(value: (SDKHandle) | null)var fromValue: SIMD2<Float>? { get set }byValue
TypeScriptget byValue32510(): (SDKHandle) | nullvar byValue: SIMD3<Float>? { get set }byValue
TypeScriptset byValue32510(value: (SDKHandle) | null)var byValue: SIMD3<Float>? { get set }toValue
TypeScriptget toValue61294(): (SDKHandle) | nullvar toValue: SIMD3<Float>? { get set }toValue
TypeScriptset toValue61294(value: (SDKHandle) | null)var toValue: SIMD3<Float>? { get set }fromValue
TypeScriptget fromValue15307(): (SDKHandle) | nullvar fromValue: SIMD3<Float>? { get set }fromValue
TypeScriptset fromValue15307(value: (SDKHandle) | null)var fromValue: SIMD3<Float>? { get set }byValue
TypeScriptget byValue62605(): (SDKHandle) | nullvar byValue: SIMD4<Float>? { get set }byValue
TypeScriptset byValue62605(value: (SDKHandle) | null)var byValue: SIMD4<Float>? { get set }toValue
TypeScriptget toValue40137(): (SDKHandle) | nullvar toValue: SIMD4<Float>? { get set }toValue
TypeScriptset toValue40137(value: (SDKHandle) | null)var toValue: SIMD4<Float>? { get set }fromValue
TypeScriptget fromValue99140(): (SDKHandle) | nullvar fromValue: SIMD4<Float>? { get set }fromValue
TypeScriptset fromValue99140(value: (SDKHandle) | null)var fromValue: SIMD4<Float>? { get set }bindTarget
TypeScriptget bindTarget(): BindTargetvar bindTarget: BindTarget { get set }A textual name that identifies the particular property that animates.
bindTarget
TypeScriptset bindTarget(value: BindTarget)var bindTarget: BindTarget { get set }A textual name that identifies the particular property that animates.
blendLayer
TypeScriptget blendLayer(): numbervar blendLayer: Int32 { get set }The order in which the framework composites the animation. The framework applies multiple animations on the same target in ascending order of this property’s value. Animations in a lower layer run before animations in a higher layer. Animations that share the same value apply in the order that they execute.
blendLayer
TypeScriptset blendLayer(value: number)var blendLayer: Int32 { get set }The order in which the framework composites the animation. The framework applies multiple animations on the same target in ascending order of this property’s value. Animations in a lower layer run before animations in a higher layer. Animations that share the same value apply in the order that they execute.
isAdditive
TypeScriptget isAdditive(): booleanvar isAdditive: Bool { get set }A Boolean value that indicates whether the animation builds on the current state of the target entity or resets the state before running.
isAdditive
TypeScriptset isAdditive(value: boolean)var isAdditive: Bool { get set }A Boolean value that indicates whether the animation builds on the current state of the target entity or resets the state before running.
repeatMode
TypeScriptget repeatMode(): AnimationRepeatModevar repeatMode: AnimationRepeatMode { get set }An option that determines how the animation repeats. If you call ``BlendTreeAnimation/trimmed(start:end:duration:)`` with a `start` or `end` that lies outside of the timeline defined by ``BlendTreeAnimation/duration``, the animation fills the additional playback by applying this property.
repeatMode
TypeScriptset repeatMode(value: AnimationRepeatMode)var repeatMode: AnimationRepeatMode { get set }An option that determines how the animation repeats. If you call ``BlendTreeAnimation/trimmed(start:end:duration:)`` with a `start` or `end` that lies outside of the timeline defined by ``BlendTreeAnimation/duration``, the animation fills the additional playback by applying this property.
trimDuration
TypeScriptget trimDuration(): (number) | nullvar trimDuration: TimeInterval? { get set }An optional duration that overrides the calculated duration. The framework calculates ``FromToByAnimation/duration``, but you can set this property to override it. This property is `nil` by default, which indicates that the animation stops after one play that spans ``BlendTreeAnimation/duration``. If you set a non-zero value for this property and both ``BlendTreeAnimation/trimStart`` and ``BlendTreeAnimation/trimEnd`` are `nil`, the animation observes this property as an edited duration. When you set ``BlendTreeAnimation/repeatMode`` to make the animation repeat: - If this property is `nil`, the animation repeats forever. - If set to a value greater than ``BlendTreeAnimation/duration``, the animation repeats for the specified duration.
trimDuration
TypeScriptset trimDuration(value: (number) | null)var trimDuration: TimeInterval? { get set }An optional duration that overrides the calculated duration. The framework calculates ``FromToByAnimation/duration``, but you can set this property to override it. This property is `nil` by default, which indicates that the animation stops after one play that spans ``BlendTreeAnimation/duration``. If you set a non-zero value for this property and both ``BlendTreeAnimation/trimStart`` and ``BlendTreeAnimation/trimEnd`` are `nil`, the animation observes this property as an edited duration. When you set ``BlendTreeAnimation/repeatMode`` to make the animation repeat: - If this property is `nil`, the animation repeats forever. - If set to a value greater than ``BlendTreeAnimation/duration``, the animation repeats for the specified duration.
name
TypeScriptget name(): stringvar name: String { get set }A textual name for the animation.
name
TypeScriptset name(value: string)var name: String { get set }A textual name for the animation.
root
TypeScriptget root(): SDKHandlevar root: any BlendTreeNode { get set }The first node in a tree of animations. This property defines the node that represents the root of a blend tree. If you assign this property a ``BlendTreeBlendNode`` instance, the root branches for every member you add to the instance's ``BlendTreeBlendNode/sources`` property. If you define a ``BlendTreeSourceNode`` instance to this property, the tree contains a single animation, which blends with no other animations.
root
TypeScriptset root(value: SDKHandle)var root: any BlendTreeNode { get set }The first node in a tree of animations. This property defines the node that represents the root of a blend tree. If you assign this property a ``BlendTreeBlendNode`` instance, the root branches for every member you add to the instance's ``BlendTreeBlendNode/sources`` property. If you define a ``BlendTreeSourceNode`` instance to this property, the tree contains a single animation, which blends with no other animations.
delay
TypeScriptget delay(): numbervar delay: TimeInterval { get set }An amount of time that lapses before the animation plays. The default value is `0`, which indicates that the animation plays with no delay. If you set a value for this property, the animation plays from its start time after the specified delay lapses. During the delayed time, the animation doesn't update. However, to fill the delayed time with some portion of animation, set a negative ``BlendTreeAnimation/trimStart`` instead and choose a ``OrbitAnimation/fillMode`` that displays the desired portion of animation.
delay
TypeScriptset delay(value: number)var delay: TimeInterval { get set }An amount of time that lapses before the animation plays. The default value is `0`, which indicates that the animation plays with no delay. If you set a value for this property, the animation plays from its start time after the specified delay lapses. During the delayed time, the animation doesn't update. However, to fill the delayed time with some portion of animation, set a negative ``BlendTreeAnimation/trimStart`` instead and choose a ``OrbitAnimation/fillMode`` that displays the desired portion of animation.
speed
TypeScriptget speed(): numbervar speed: Float { get set }A factor that increases or decreases the animation’s rate of playback. The default value is `1.0`, which doesn’t alter the animation’s rate of playback. A value of `2.0` plays the animation at twice the normal rate, and a speed of `0.5` makes the animation finish after twice the normal time. A negative value plays the animation in reverse. This property doesn’t affect the animation’s ``FromToByAnimation/delay``.
speed
TypeScriptset speed(value: number)var speed: Float { get set }A factor that increases or decreases the animation’s rate of playback. The default value is `1.0`, which doesn’t alter the animation’s rate of playback. A value of `2.0` plays the animation at twice the normal rate, and a speed of `0.5` makes the animation finish after twice the normal time. A negative value plays the animation in reverse. This property doesn’t affect the animation’s ``FromToByAnimation/delay``.
offset
TypeScriptget offset(): numbervar offset: TimeInterval { get set }The time, in seconds, at which the animation begins within the duration. The default value is `0`, which indicates that the animation plays with no offset. Setting a value for this property moves the animation data along the timeline and doesn't change timing. If you set a ``BlendTreeAnimation/fillMode`` other than ``AnimationFillMode/none``, the animation fills the vacant area created by the offset according to the characteristics of the specified fill mode.
offset
TypeScriptset offset(value: number)var offset: TimeInterval { get set }The time, in seconds, at which the animation begins within the duration. The default value is `0`, which indicates that the animation plays with no offset. Setting a value for this property moves the animation data along the timeline and doesn't change timing. If you set a ``BlendTreeAnimation/fillMode`` other than ``AnimationFillMode/none``, the animation fills the vacant area created by the offset according to the characteristics of the specified fill mode.
trimEnd
TypeScriptget trimEnd(): (number) | nullvar trimEnd: TimeInterval? { get set }The optional time, in seconds, at which the source animation stops. This property is `nil` by default, which plays the animation until `time` = ``BlendTreeAnimation/duration``. If you set a value, the animation edits the duration according to the specified ending time.
trimEnd
TypeScriptset trimEnd(value: (number) | null)var trimEnd: TimeInterval? { get set }The optional time, in seconds, at which the source animation stops. This property is `nil` by default, which plays the animation until `time` = ``BlendTreeAnimation/duration``. If you set a value, the animation edits the duration according to the specified ending time.
duration
TypeScriptget duration(): numbervar duration: TimeInterval { get }The total playback time of the animation. The framework sets a value for this property depending on the underlying animation data and the specified ``AnimationView/speed``. You can override the default duration by defining ``AnimationView/trimStart``, ``AnimationView/trimEnd``, or ``AnimationView/trimDuration``.
fillMode
TypeScriptget fillMode(): AnimationFillModevar fillMode: AnimationFillMode { get set }An option that determines which data displays outside of the normal duration. This property determines what to display when the framework samples the animation outside of the range defined by its underlying duration. The animation applies this property when: - Playback progresses toward, but hasn't yet reached, a nonzero ``AnimationDefinition/offset``. - A range determined by ``AnimationDefinition/trimStart``, ``AnimationDefinition/trimEnd``, or ``AnimationDefinition/trimDuration`` exceeds the animation's underlying duration.
fillMode
TypeScriptset fillMode(value: AnimationFillMode)var fillMode: AnimationFillMode { get set }An option that determines which data displays outside of the normal duration. This property determines what to display when the framework samples the animation outside of the range defined by its underlying duration. The animation applies this property when: - Playback progresses toward, but hasn't yet reached, a nonzero ``AnimationDefinition/offset``. - A range determined by ``AnimationDefinition/trimStart``, ``AnimationDefinition/trimEnd``, or ``AnimationDefinition/trimDuration`` exceeds the animation's underlying duration.
trimStart
TypeScriptget trimStart(): (number) | nullvar trimStart: TimeInterval? { get set }The optional time, in seconds, at which the source animation plays. This property is `nil` by default, which plays the animation with `time` = `0`. If you set a value, the animation edits the duration according to the specified beginning time. If you set a negative value for this property, the duration increases and the additional animation data fills in based on the ``AnimationView/fillMode`` you choose.
trimStart
TypeScriptset trimStart(value: (number) | null)var trimStart: TimeInterval? { get set }The optional time, in seconds, at which the source animation plays. This property is `nil` by default, which plays the animation with `time` = `0`. If you set a value, the animation edits the duration according to the specified beginning time. If you set a negative value for this property, the duration increases and the additional animation data fills in based on the ``AnimationView/fillMode`` you choose.
init
TypeScriptstatic init(root: SDKHandle, name?: string, isAdditive?: boolean, bindTarget?: (BindTarget) | null, blendLayer?: number, repeatMode?: AnimationRepeatMode, fillMode?: AnimationFillMode, trimStart?: (number) | null, trimEnd?: (number) | null, trimDuration?: (number) | null, offset?: number, delay?: number, speed?: number): BlendTreeAnimation<number>init(_ root: any BlendTreeNode, name: String = "", isAdditive: Bool = false, bindTarget: BindTarget? = nil, blendLayer: Int32 = 0, repeatMode: AnimationRepeatMode = .none, fillMode: AnimationFillMode = [], trimStart: TimeInterval? = nil, trimEnd: TimeInterval? = nil, trimDuration: TimeInterval? = nil, offset: TimeInterval = 0, delay: TimeInterval = 0, speed: Float = 1)Creates a unique animation from a combination of other animations in the form of a tree. - Parameters: - root: The first node in a tree of animations. - name: A textual name for the 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. - bindTarget: A textual name that identifies the particular property that animates. - blendLayer: The order in which the framework composites the animation into the view. - repeatMode: An option that determines how the animation repeats. - fillMode: The behavior when the animated property reaches its end value. - trimStart: The optional time, in seconds, at which the source animation plays. - trimEnd: The optional time, in seconds, at which the source animation stops. - trimDuration: An optional duration that overrides the calculated duration. - offset: The time, in seconds, at which the animation begins within the duration. - delay: An amount of time that lapses before the animation plays. - speed: A factor that increases or decreases the animation’s rate of playback.
inputBuffers
TypeScriptget inputBuffers(): MeshDeformParameter_VertexBuffers<unknown, unknown, unknown>var inputBuffers: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<InputBuffer>The specified input vertex data for the deformer function.
inputBuffers
TypeScriptset inputBuffers(value: MeshDeformParameter_VertexBuffers<unknown, unknown, unknown>)var inputBuffers: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<InputBuffer>The specified input vertex data for the deformer function.
bitangents
TypeScriptget bitangents(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet bitangents: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The bitangents buffer, if the custom deformer author specified it.
uvs
TypeScriptget uvs(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet uvs: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The uvs buffer, if the custom deformer author specified it
buffer
TypeScriptget buffer(): unknownlet buffer: BufferThe allocation containing the vertex data.
format
TypeScriptget format(): _Metal_MTLVertexFormatlet format: MTLVertexFormatThe format of the vertices.
offset
TypeScriptget offset(): numberlet offset: IntThe offset of the vertex data.
stride
TypeScriptget stride(): numberlet stride: IntThe stride of the vertex data.
uv1s
TypeScriptget uv1s(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet uv1s: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The uv1s buffer, if the custom deformer author specified it
uv2s
TypeScriptget uv2s(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet uv2s: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The uv2s buffer, if the custom deformer author specified it
uv3s
TypeScriptget uv3s(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet uv3s: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The uv3s buffer, if the custom deformer author specified it
uv4s
TypeScriptget uv4s(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet uv4s: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The uv4s buffer, if the custom deformer author specified it
uv5s
TypeScriptget uv5s(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet uv5s: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The uv5s buffer, if the custom deformer author specified it
uv6s
TypeScriptget uv6s(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet uv6s: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The uv6s buffer, if the custom deformer author specified it
uv7s
TypeScriptget uv7s(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet uv7s: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The uv7s buffer, if the custom deformer author specified it
count
TypeScriptget count(): numberlet count: IntThe number of elements in each of the specified buffers.
normals
TypeScriptget normals(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet normals: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The normals buffer, if the custom deformer author specified it.
tangents
TypeScriptget tangents(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet tangents: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The tangents buffer, if the custom deformer author specified it.
positions
TypeScriptget positions(): (MeshDeformParameter_VertexBuffers_Data<unknown, unknown, unknown>) | nulllet positions: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<Buffer>.Data?The positions buffer, if the custom deformer author specified it.
outputBuffers
TypeScriptget outputBuffers(): MeshDeformParameter_VertexBuffers<unknown, unknown, unknown>var outputBuffers: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<OutputBuffer>The specified output vertex data for the deformer function.
outputBuffers
TypeScriptset outputBuffers(value: MeshDeformParameter_VertexBuffers<unknown, unknown, unknown>)var outputBuffers: MeshDeformParameter<InputBuffer, OutputBuffer>.VertexBuffers<OutputBuffer>The specified output vertex data for the deformer function.
duration
TypeScriptget duration(): numbervar duration: TimeIntervalThe event interval's duration.
duration
TypeScriptset duration(value: number)var duration: TimeIntervalThe event interval's duration.
parameter
TypeScriptget parameter(): (SDKHandle) | nullvar parameter: ActionEventDefinition<ActionType>.EventParameterType?Optional parameter data available to the event handler at the time of the event.
parameter
TypeScriptset parameter(value: (SDKHandle) | null)var parameter: ActionEventDefinition<ActionType>.EventParameterType?Optional parameter data available to the event handler at the time of the event.
startTime
TypeScriptget startTime(): numbervar startTime: TimeIntervalThe time at which the event interval starts.
startTime
TypeScriptset startTime(value: number)var startTime: TimeIntervalThe time at which the event interval starts.
makeIterator
TypeScriptmakeIterator(): UnsafeForceEffectBuffer_Iterator<unknown>func makeIterator() -> UnsafeForceEffectBuffer<T>.IteratorReturns an iterator for the sequence.
count
TypeScriptget count(): numbervar count: Int { get }Returns the number of elements in the buffer.
next
TypeScriptnext(): (unknown) | nullmutating func next() -> T?Advances to the next element and returns it, or `nil` if no next element exists. Repeatedly calling this method returns, in order, all the elements of the underlying sequence. As soon as the sequence has run out of elements, all subsequent calls return `nil`. You must not call this method if any other copy of this iterator has been advanced with a call to its `next()` method. The following example shows how an iterator can be used explicitly to emulate a `for`-`in` loop. First, retrieve a sequence's iterator, and then call the iterator's `next()` method until it returns `nil`. let numbers = [2, 3, 5, 7] var numbersIterator = numbers.makeIterator() while let num = numbersIterator.next() { print(num) } // Prints "2" // Prints "3" // Prints "5" // Prints "7" - Returns: The next element in the underlying sequence, if a next element exists; otherwise, `nil`.
subscript
TypeScriptsubscript(index: number): unknownsubscript(index: Int) -> T { get }Returns an element by index. The index should be in the range [0, ``ForceEffectParameters/physicsBodyCount``].
blend
TypeScriptblendSourcesNameIsAdditive(sources: Array<SDKHandle>, name?: string, isAdditive?: boolean): SDKHandlefunc blend(sources: [any BlendTreeNode], name: String = "", isAdditive: Bool = false) -> any BlendTreeNodeCombines the animations that result from the individual blend-tree nodes of the given array to a single blend-tree node. - Parameters: - sources: The blend-tree nodes to combine. - name: A unique name for the combined node. - isAdditive: A Boolean value that indicates whether the animation builds on the current state of the target entity, or resets the state before running. - Returns: A blend-tree node that combines the given animations.
blend
TypeScriptblendNameIsAdditive(x: SDKHandle, y: SDKHandle, name?: string, isAdditive?: boolean): SDKHandlefunc blend(_ x: any BlendTreeNode, _ y: any BlendTreeNode, name: String = "", isAdditive: Bool = false) -> any BlendTreeNodeCombines the animations that result from two blend-tree nodes into a single blend-tree node. - Parameters: - x: A blend-tree node whose animation combines with the second animation argument. - y: A blend-tree node whose animation combines with the first animation argument. - name: A unique name for the combined node. - isAdditive: A Boolean value that indicates whether the animation builds on the current state of the target entity, or resets the state before running. - Returns: A blend-tree node that combines the given animations.
present
Swift declarationfunc present(_ drawable: TextureResource.Drawable)Registers a drawable presentation to occur as soon as possible - drawable: The drawable that you want to present.
init
TypeScriptstatic init(transform: Transform): _Spatial_AffineTransform3Dinit(_ transform: Transform)init
TypeScriptstatic init(bounds: BoundingBox): _Spatial_Rect3Dinit(_ bounds: BoundingBox)Skipped declarations
190 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.
AudioLibraryComponent.init(dictionaryLiteral:)
A variable number of Swift arguments is not supported.
RealityRenderer.subscribe(to:on:componentType:_:)
Passing a Swift type itself is not supported.
EmphasizeAction.animatedValueType
Passing a Swift type itself is not supported.
BillboardAction.animatedValueType
Passing a Swift type itself is not supported.
PhysicsJoints.init(arrayLiteral:)
A variable number of Swift arguments is not supported.
RealityCoordinateSpace.scene
Static protocol requirements cannot be called through an instance.
RealityCoordinateSpace.camera
Static protocol requirements cannot be called through an instance.
PlayAnimationAction.animatedValueType
Passing a Swift type itself is not supported.
Audio.Scattering.scaled(by:)
callback cannot propagate synchronous failure
Audio.Scattering.init(dictionaryLiteral:)
A variable number of Swift arguments is not supported.
OrbitEntityAction.animatedValueType
Passing a Swift type itself is not supported.
IKRig.ConstraintsCollection.init(arrayLiteral:)
A variable number of Swift arguments is not supported.
ImpulseAction.animatedValueType
Passing a Swift type itself is not supported.
FromToByAction.animatedValueType
Passing a Swift type itself is not supported.
ActionEvent.action
This declaration needs Swift generic type arguments. (no canonical witness for ActionType)
ActionEvent.parameter
This declaration needs Swift generic type arguments. (no canonical witness for ActionType.EventParameterType)
ActionHandlerProtocol.actionStarted(event:)
The iOS SDK compiler rejected this binding: cannot access type alias 'EventType' from 'ActionHandlerProtocol'; use a concrete type or generic parameter base instead
ActionHandlerProtocol.actionUpdated(event:)
The iOS SDK compiler rejected this binding: cannot access type alias 'EventType' from 'ActionHandlerProtocol'; use a concrete type or generic parameter base instead
ActionHandlerProtocol.actionEnded(event:)
The iOS SDK compiler rejected this binding: cannot access type alias 'EventType' from 'ActionHandlerProtocol'; use a concrete type or generic parameter base instead
ActionHandlerProtocol.actionSkipped(event:)
The iOS SDK compiler rejected this binding: cannot access type alias 'EventType' from 'ActionHandlerProtocol'; use a concrete type or generic parameter base instead
ActionHandlerProtocol.actionPaused(event:)
The iOS SDK compiler rejected this binding: cannot access type alias 'EventType' from 'ActionHandlerProtocol'; use a concrete type or generic parameter base instead
ActionHandlerProtocol.actionResumed(event:)
The iOS SDK compiler rejected this binding: cannot access type alias 'EventType' from 'ActionHandlerProtocol'; use a concrete type or generic parameter base instead
ActionHandlerProtocol.actionTerminated(event:)
The iOS SDK compiler rejected this binding: cannot access type alias 'EventType' from 'ActionHandlerProtocol'; use a concrete type or generic parameter base instead
ActionHandlerProtocol.register(_:)
callback cannot propagate synchronous failure
ActionHandlerProtocol.register(_:)
callback cannot propagate synchronous failure
EntityAction.registerAction()
Static protocol requirements cannot be called through an instance.
EntityAction.subscribe(to:_:)
This protocol needs associated types that cannot yet cross the bridge.
EntityAction.unsubscribe(from:)
Static protocol requirements cannot be called through an instance.
EntityAction.unsubscribeAll()
Static protocol requirements cannot be called through an instance.
EntityAction.registerAction()
Static protocol requirements cannot be called through an instance.