Component:AvatarPoseRotationConstraint: Difference between revisions

Revision as of 03:25, 13 November 2024

Component image

**AvatarPoseRotationConstraint** component as seen in the Scene Inspector

The AvatarPoseRotationConstraint component is used to either restrict the rotation direction of the user's arm when using a tooltip, or to restrict the rotation of a particular BodyNode when the user is in a Component:AvatarAnchor.

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`MaxTwist`	Float	the max twist in degrees allowed for the object being filtered.
`MaxSwing`	Float	the max swing in degrees allowed for the object being filtered.
`Axis`	Float3	swing axis direction for the object being filtered.
`TwistReferenceAxis`	Float3	The twist axis direction for the object being filtered.

Usage

Used in avatar anchors and in tooltip contraints.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=AvatarPoseRotationConstraintComponent.png
 |Name=AvatarPoseRotationConstraint
 }}
+The '''AvatarPoseRotationConstraint''' component is used to either restrict the rotation direction of the user's arm when using a tooltip, or to restrict the rotation of a particular [[Type:BodyNode|BodyNode]] when the user is in a [[Component:AvatarAnchor]].
-<!--T:2-->
-== Intoduction ==
 <!--T:3-->
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|MaxTwist|Float|
+|MaxTwist|Float| the max twist in degrees allowed for the object being filtered.
-|MaxSwing|Float|
+|MaxSwing|Float| the max swing in degrees allowed for the object being filtered.
-|Axis|Float3|
+|Axis|Float3| swing axis direction for the object being filtered.
-|TwistReferenceAxis|Float3|
+|TwistReferenceAxis|Float3| The twist axis direction for the object being filtered.
 }}
 <!--T:4-->
-== Behavior ==
+== Usage ==
+Used in avatar anchors and in tooltip contraints.
 <!--T:5-->
 == Examples ==
+{{stub}}
 <!--T:6-->
-== Related Components ==
+== See Also ==
+* [[Component:AvatarPoseSmoothLerp]]
+* [[Component:AvatarPoseOffset]]
+* [[Component:AvatarPoseRotationConstraint]]
+* [[Component:AvatarPoseBoxConstraint]]
 </translate>
 [[Category:Components{{#translation:}}|Avatar Pose Rotation Constraint]]
-[[Category:ComponentStubs]]
 [[Category:Components:Users:Common Avatar System:Pose Filters{{#translation:}}|Avatar Pose Rotation Constraint]]