Component:PositionDeltaDriver: Difference between revisions

From Resonite Wiki
Automated: update Fields
add info
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=PositionDeltaDriverComponent.png
|Image=PositionDeltaDriverComponent.png
|Name=Position Delta Driver
|Name=Position Delta Driver
}}
}}
The '''PositionDeltaDriver''' component drives a field with a vector drawn from <code>Origin</code> to <code>Target</code> in global space transformed (optionally normalized) into space <code>VectorSpace</code>.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Origin|{{RootFieldType|TransformRelayRef}}|TypeAdv0=true|
|Origin|{{RootFieldType|TransformRelayRef}}|TypeAdv0=true| The Origin starting point for the vector, defaults to root if null.
|Target|{{RootFieldType|TransformRelayRef}}|TypeAdv1=true|
|Target|{{RootFieldType|TransformRelayRef}}|TypeAdv1=true| The target for the vector. Defaults to root if null.
|VectorSpace|{{RootFieldType|RootSpace}}|TypeAdv2=true|
|VectorSpace|{{RootFieldType|RootSpace}}|TypeAdv2=true| The coordinate space to calculate the vector result in for <code>Origin</code> and <code>Target</code>
|Normalized|Bool|
|Normalized|Bool| Whether the vector from <code>Origin</code> to <code>Target</code> in <code>VectorSpace</code> should be normalized.
|Vector|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv4=true|
|Vector|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv4=true| The field to drive with the vector from <code>Origin</code> to <code>Target</code> in the coordinate space <code>VectorSpace</code>
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Provide at least a <code>Target</code> slot and a value to drive for <code>Vector</code> to use this component.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Position Delta Driver]]
[[Category:Components{{#translation:}}|Position Delta Driver]]
[[Category:Components:Transform:Drivers{{#translation:}}|Position Delta Driver]]
[[Category:Components:Transform:Drivers{{#translation:}}|Position Delta Driver]]

Latest revision as of 18:10, 31 January 2025

Component image 
Position Delta Driver component as seen in the Scene Inspector

The PositionDeltaDriver component drives a field with a vector drawn from Origin to Target in global space transformed (optionally normalized) into space VectorSpace.

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.
Origin direct TransformRelayRef The Origin starting point for the vector, defaults to root if null.
Target direct TransformRelayRef The target for the vector. Defaults to root if null.
VectorSpace direct RootSpace The coordinate space to calculate the vector result in for Origin and Target
Normalized Bool Whether the vector from Origin to Target in VectorSpace should be normalized.
Vector field drive of Float3 The field to drive with the vector from Origin to Target in the coordinate space VectorSpace

Usage

Provide at least a Target slot and a value to drive for Vector to use this component.

Examples

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


See Also