Component:AvatarPoseNode: Difference between revisions

From Resonite Wiki
← Older editNewer edit →
VisualWikitext
fix
add info
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AvatarPoseNodeComponent.png
|Image=AvatarPoseNodeComponent.png
|Name=AvatarPoseNode
|Name=Avatar Pose Node
}}
}}
 
The '''AvatarPoseNode''' component is activated when a user equips an avatar with this component under it. The component drives the transforms of the slot it is on, in order to copy the transforms of an [[Component:AvatarObjectSlot]] of the given <code>Node</code>.
<!--T:2-->
== Intoduction ==


<!--T:3-->
<!--T:3-->
== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Node|BodyNode|
|Node|BodyNode| the node this component is  copying.
|EquipOrderPriority|Int|
|EquipOrderPriority|Int| The priority of this node being updated in the list of Pose Nodes on an Avatar.
|RunAfterInputUpdate|Bool|
|RunAfterInputUpdate|Bool| Whether to run this component's copy Behavior after the engine's input received stage.
|MutuallyExclusiveNodes|{{RootFieldType|SyncFieldList`1|[[Type:BodyNode|BodyNode]]}}|TypeAdv3=true|
|MutuallyExclusiveNodes|{{RootFieldType|SyncFieldList`1|[[Type:BodyNode|BodyNode]]}}|TypeAdv3=true|
|IsTracking|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv4=true|
|IsTracking|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv4=true| Whether this component is tracking
|SourceIsTracking|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv5=true|
|SourceIsTracking|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv5=true| Whether the source <code>_objectSlot</code> is currently tracking an inputting object like a controller or FBT device
|SourceIsActive|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv6=true|
|SourceIsActive|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv6=true| Whether the source <code>_objectSlot</code> is active.
|SourceIsSimulated|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv7=true|
|SourceIsSimulated|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv7=true| Whether the source <code>_objectSlot</code> is being simulated by the procedural animation system.
|_objectSlot|'''[[Component:AvatarObjectSlot|AvatarObjectSlot]]'''|TypeAdv8=true|
|_objectSlot|'''[[Component:AvatarObjectSlot|AvatarObjectSlot]]'''|TypeAdv8=true| The object slot this component is getting pose data and tracking data from.
|_source|Slot|
|_source|Slot| the slot of <code>_objectSlot</code>
|_position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv10=true|
|_position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv10=true| The position field to drive to the pose data. Usually the position field of the slot this component is on.
|_rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv11=true|
|_rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv11=true| The rotation field to drive to the pose data. Usually the rotation field of the slot this component is on.
|_scale|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv12=true|
|_scale|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv12=true| The scale to drive to the scale of <code>_source</code> if drive scale is enabled on the <code>_objectSlot</code>.
|_active|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv13=true|
|_active|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv13=true| Whether this component is currently active and setting pose data.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
{{stub}}


<!--T:5-->
<!--T:5-->
Line 37: Line 35:


<!--T:6-->
<!--T:6-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:Components{{#translation:}}|Avatar Pose Node]]
[[Category:Components{{#translation:}}|Avatar Pose Node]]
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Pose Node]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Pose Node]]

Revision as of 20:10, 29 December 2024

Component image 
Avatar Pose Node component as seen in the Scene Inspector

The AvatarPoseNode component is activated when a user equips an avatar with this component under it. The component drives the transforms of the slot it is on, in order to copy the transforms of an Component:AvatarObjectSlot of the given Node.

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.
Node BodyNode the node this component is copying.
EquipOrderPriority Int The priority of this node being updated in the list of Pose Nodes on an Avatar.
RunAfterInputUpdate Bool Whether to run this component's copy Behavior after the engine's input received stage.
MutuallyExclusiveNodes direct SyncFieldList`1<BodyNode>
IsTracking raw output of Bool Whether this component is tracking
SourceIsTracking raw output of Bool Whether the source _objectSlot is currently tracking an inputting object like a controller or FBT device
SourceIsActive raw output of Bool Whether the source _objectSlot is active.
SourceIsSimulated raw output of Bool Whether the source _objectSlot is being simulated by the procedural animation system.
_objectSlot AvatarObjectSlot The object slot this component is getting pose data and tracking data from.
_source Slot the slot of _objectSlot
_position field drive of Float3 The position field to drive to the pose data. Usually the position field of the slot this component is on.
_rotation field drive of FloatQ The rotation field to drive to the pose data. Usually the rotation field of the slot this component is on.
_scale field drive of Float3 The scale to drive to the scale of _source if drive scale is enabled on the _objectSlot.
_active field drive of Bool Whether this component is currently active and setting pose data.

Usage

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


Examples

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:AvatarPoseNode&oldid=93894"