Component:AvatarPoseBoxConstraint: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
Add info
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
Avatar Pose Box Constraint is a BodyPoseFilter that can be used in the construction of tool tips, anchors, and more.
This Component is used as a reference to tell for example an [[Component:AvatarAnchor#BodyPoseFilters|Avatar Anchor body pose filter]] how to constrain the specified body node when a user enters the anchor.
{{Infobox Component
{{Infobox Component
|Image=AvatarPoseBoxConstraintComponent.png
|Image=AvatarPoseBoxConstraintComponent.png
|Name=AvatarPoseBoxConstraint
|Name=AvatarPoseBoxConstraint
}}
}}
<!--T:2-->
== Intoduction ==


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|BoxSize|Float3|
|BoxSize|Float3| the size of the box that a user's body node should be constrained within. (0,0,0) is valid for this field.
|DefaultPoseReference|Slot|
|DefaultPoseReference|Slot| the slot which the box will be positioned, rotated, and scaled by. If null, this is the slot this component is on.
}}
}}


Line 23: Line 21:
<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
This is widely used in seats where the user's legs and hips are posed in a sitting position, like when sitting in a car.


<!--T:6-->
<!--T:6-->
Line 28: Line 27:
</translate>
</translate>
[[Category:Components{{#translation:}}|Avatar Pose Box Constraint]]
[[Category:Components{{#translation:}}|Avatar Pose Box Constraint]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System:Pose Filters{{#translation:}}|Avatar Pose Box Constraint]]
[[Category:Components:Users:Common Avatar System:Pose Filters{{#translation:}}|Avatar Pose Box Constraint]]

Latest revision as of 16:29, 14 October 2024

Avatar Pose Box Constraint is a BodyPoseFilter that can be used in the construction of tool tips, anchors, and more. This Component is used as a reference to tell for example an Avatar Anchor body pose filter how to constrain the specified body node when a user enters the anchor.

Component image 
AvatarPoseBoxConstraint component as seen in the Scene Inspector


Usage

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.
BoxSize Float3 the size of the box that a user's body node should be constrained within. (0,0,0) is valid for this field.
DefaultPoseReference Slot the slot which the box will be positioned, rotated, and scaled by. If null, this is the slot this component is on.

Behavior

Examples

This is widely used in seats where the user's legs and hips are posed in a sitting position, like when sitting in a car.

Related Components