Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ParentConstraint

class in UnityEngine.Animations

/

Inherits from:Behaviour

/

Implemented in:UnityEngine.AnimationModule


Implements interfaces:IConstraint

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

Constrains the orientation and translation of an object to one or more source objects. The constrained object behaves as if it is in the hierarchy of the sources.

Properties

constraintActiveActivates or deactivates the constraint.
lockedLocks the offsets and position (translation and rotation) at rest.
rotationAtRestThe rotation used when the sources have a total weight of 0.
rotationAxisThe rotation axes affected by the ParentConstraint.
rotationOffsetsThe rotation offsets from the constrained orientation.
sourceCountThe number of sources set on the component (read-only).
translationAtRestThe position of the object in local space, used when the sources have a total weight of 0.
translationAxisThe translation axes affected by the ParentConstraint.
translationOffsetsThe translation offsets from the constrained orientation.
weightThe weight of the constraint component.

Public Methods

AddSourceAdds a constraint source.
GetRotationOffsetGets the rotation offset associated with a source by index.
GetSourceGets a constraint source by index.
GetSourcesGets the list of sources.
GetTranslationOffsetGets the rotation offset associated with a source by index.
RemoveSourceRemoves a source from the component.
SetRotationOffsetSets the rotation offset associated with a source by index.
SetSourceSets a source at a specified index.
SetSourcesSets the list of sources on the component.
SetTranslationOffsetSets the translation offset associated with a source by index.

Inherited Members

Properties

enabledEnabled Behaviours are Updated, disabled Behaviours are not.
isActiveAndEnabledHas the Behaviour had enabled called.
gameObjectThe game object this component is attached to. A component is always attached to a game object.
tagThe tag of this game object.
transformThe Transform attached to this GameObject.
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Methods

BroadcastMessageCalls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTagIs this game object tagged with tag ?
GetComponentReturns the component of Type type if the game object has one attached, null if it doesn't.
GetComponentInChildrenReturns the component of Type type in the GameObject or any of its children using depth first search.
GetComponentInParentReturns the component of Type type in the GameObject or any of its parents.
GetComponentsReturns all components of Type type in the GameObject.
GetComponentsInChildrenReturns all components of Type type in the GameObject or any of its children.
GetComponentsInParentReturns all components of Type type in the GameObject or any of its parents.
SendMessageCalls the method named methodName on every MonoBehaviour in this game object.
SendMessageUpwardsCalls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the GameObject.

Static Methods

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

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