Class ZivaRTPlayer

A ZivaRT runtime component that can be attached to a GameObject. When configured properly this will allow for Ziva to be used to deform skin a mesh.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

ZivaRTPlayer

Implements

IAnimationWindowPreview

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Namespace: Global Namespace

Assembly: solution.dll

Syntax

[RequireComponent(typeof(Animator))]
[RequireComponent(typeof(MeshFilter))]
[RequireComponent(typeof(MeshRenderer))]
[ExecuteInEditMode]
public class ZivaRTPlayer : MonoBehaviour, IAnimationWindowPreview

Fields

Name	Description
DrawDebugVertices	Draw the vertices of the imported ZivaRT asset's rest shape in the Scene view. Can be useful to diagnose vertex mapping issues.
SuppressGeometryWarningMessages	Don't print out warnings about issues discovered with the mesh, eg: degenerate face UVs.

Properties

Name	Description
AnimationRoot	The animation root for which the animation should be applied from
AutoBounds	Automatically generated bounds used for visibility culling.
CalculateMotionVectors	Should motion vectors for deformed positions be calculated?
CustomBounds	The custom bounds used for visibility culling.
EnableCorrectives	Whether to apply pre-skinning correctives from the ZivaRT solver (generally used for debugging).
EnableSkinning	Whether to apply skinning to the mesh using the ZivaRT solver (used for debugging).
ExecutionSchedule	Should deformation calculations be started manually, in the LateUpdate phase or normal Update phase?
GameObjectRoot	The GameObject root for which the animation should be applied from
Implementation	Select which internal implementation is used to perform the deformation. Different implementations have different properties (CPU vs GPU).
MeshRescale	Scale factor that should be applied to the Ziva RT vertices to match the mesh scaling applied on the imported mesh file
MultithreadedJointUpdates	Should joint transform updates execute on multiple threads? This delays solver execution to LateUpdate
RecalculateTangentFrames	Should the solver recompute target mesh normals and tangents each frame?
Rig	The ZivaRT rig asset used to deform the target character mesh.
SourceMesh	Source Mesh that will be deformed by the Ziva Rig. A copy will be created for the deformation which means this source mesh will not be modified directly.
UseCustomBounds	If this is true then custom bounds are used for mesh visibility culling. If this is false then bounds are computed automatically.
UseMeshTransformForRegistration	Apply the local transform of the Skinned Mesh during vertex correspondence registration step.

Methods

Name	Description
AddExtraParameterOverride(string, ExtraParameterOverrideValue)	Adds an override for an extra parameter identified by 'extraParameterName' this function is slow and should only be called on initialization.
GetExtraParameterNames(List<string>)	Adds the names of all of the extra parameters in this ZivaRT asset to the list.
GetMotionVectors(Vector3[])	Motion vectors. Not available if Compute Shader or Mono implementation is selected.
GetNormals(Vector3[])	Final vertex normals after ZivaRT correctives and skinning have been applied. Not available if Compute Shader implementation is selected.
GetPositions(Vector3[])	Final vertex positions after ZivaRT correctives and skinning have been applied. Not available if Compute Shader implementation is selected.
GetTangents(Vector4[])	Final vertex tangents after ZivaRT correctives and skinning have been applied. Not available if Compute Shader implementation is selected.
RemoveExtraParameterOverride(string)	Removes an override for an extra parameter identified by 'extraParameterName' this function is slow and should only be called on finalization.
RunSolver()	Runs the ZivaRT solver in it's current configuration. Note that by default the solver is already run if the object containing the ZivaRT component is visible. This method should only be used in advanced scenarios where there is a requirement to explicitely invoke the solver.
ScalarName(int)	Returns the name of the scalar at 'index'.
ScalarValue(int)	Returns the value of the scalar at 'index'.
ScalarsLength()	Returns the number of scalars in this ZivaRTPlayer component.