Legacy Documentation: Version 2018.2 (Go to current version)
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

TransformSceneHandle

struct in UnityEngine.Experimental.Animations

/

Implemented in:UnityEngine.AnimationModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Position, rotation and scale of an object in the scene.

A TransformSceneHandle is a safe handle on a TransformAccess. The Animator used to create this handle manages the validity of this handle.

using UnityEngine;
using UnityEngine.Playables;
using UnityEngine.Animations;

using UnityEngine.Experimental.Animations;

public struct TransformSceneHandleJob : IAnimationJob { public TransformSceneHandle handle; public Vector3 position; public Vector3 rotation; public Vector3 scale;

public void ProcessRootMotion(AnimationStream stream) { // Set the new local position. handle.SetLocalPosition(stream, position);

// Set the new local rotation (converted from euler). handle.SetLocalRotation(stream, Quaternion.Euler(rotation));

// Set the new local scale. handle.SetLocalScale(stream, scale); }

public void ProcessAnimation(AnimationStream stream) { } }

[RequireComponent(typeof(Animator))] public class TransformSceneHandleExample : MonoBehaviour { public Transform sceneTransform; public Vector3 position; public Vector3 rotation; public Vector3 scale = Vector3.one;

PlayableGraph m_Graph; AnimationScriptPlayable m_AnimationScriptPlayable;

void Start() { if (sceneTransform == null) return;

var animator = GetComponent<Animator>();

m_Graph = PlayableGraph.Create("TransformSceneHandleExample"); var output = AnimationPlayableOutput.Create(m_Graph, "output", animator);

var animationJob = new TransformSceneHandleJob(); animationJob.handle = animator.BindSceneTransform(sceneTransform); m_AnimationScriptPlayable = AnimationScriptPlayable.Create(m_Graph, animationJob);

output.SetSourcePlayable(m_AnimationScriptPlayable); m_Graph.Play(); }

void Update() { if (sceneTransform == null) return;

var animationJob = m_AnimationScriptPlayable.GetJobData<TransformSceneHandleJob>(); animationJob.position = position; animationJob.rotation = rotation; animationJob.scale = scale; m_AnimationScriptPlayable.SetJobData(animationJob); }

void OnDisable() { if (sceneTransform == null) return;

m_Graph.Destroy(); } }

Public Methods

GetLocalPositionGets the position of the transform relative to the parent.
GetLocalRotationGets the rotation of the transform relative to the parent.
GetLocalScaleGets the scale of the transform relative to the parent.
GetPositionGets the position of the transform in world space.
GetRotationGets the rotation of the transform in world space.
IsValidReturns whether this is a valid handle.
SetLocalPositionSets the position of the transform relative to the parent.
SetLocalRotationSets the rotation of the transform relative to the parent.
SetLocalScaleSets the scale of the transform relative to the parent.
SetPositionSets the position of the transform in world space.
SetRotationSets the rotation of the transform in world space.

Did you find this page useful? Please give it a rating: