Component:MirrorTransform: Difference between revisions

Latest revision as of 18:09, 4 December 2024

Component image

**Mirror Transform** component as seen in the Scene Inspector

The Mirror Transform drives the position of the slot to mirror the position of an inputted slot across the normal of a plane.

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.
`MirrorSource`	Slot	The slot to get the mirror data from.
`MirrorPlane`	Slot	The slot to use as the position to mirror across.
`MirrorOffset`	Float3	An offset from the `MirrorPlane` to mirror across.
`MirrorNormal`	Float3	The direction to mirror from.
`AllowWriteBack`	Bool	Whether to allow changing the target fields of `_position` or `_rotation` to change the position and rotation of `MirrorSource`.
`_position`	field drive of Float3	The position field to drive with the mirrored mirror data. Usually the Position field of the slot this component is on.
`_rotation`	field drive of FloatQ	The rotation field to drive with the mirrored mirror data. Usually the Rotation field of the slot this component is on.

Usage

Attach to a slot and provide MirrorSource, MirrorPlane, and MirrorNormal for this component to start working.

Examples

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

Related Components

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=MirrorTransformComponent.png
@@ Line 12: / Line 11: @@
 == Fields ==
 {{Table ComponentFields
-|MirrorSource|Slot|
+|MirrorSource|Slot| The slot to get the mirror data from.
-|MirrorPlane|Slot|
+|MirrorPlane|Slot| The slot to use as the position to mirror across.
-|MirrorOffset|Float3|
+|MirrorOffset|Float3| An offset from the <code>MirrorPlane</code> to mirror across.
-|MirrorNormal|Float3|
+|MirrorNormal|Float3| The direction to mirror from.
-|AllowWriteBack|Bool|
+|AllowWriteBack|Bool| Whether to allow changing the target fields of <code>_position</code> or <code>_rotation</code> to change the position and rotation of <code>MirrorSource</code>.
-|_position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv5=true|
+|_position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv5=true| The position field to drive with the mirrored mirror data. Usually the Position field of the slot this component is on.
-|_rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv6=true|
+|_rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv6=true| The rotation field to drive with the mirrored mirror data. Usually the Rotation field of the slot this component is on.
 }}
 <!--T:3-->
 == Usage ==
+Attach to a slot and provide <code>MirrorSource</code>, <code>MirrorPlane</code>, and <code>MirrorNormal</code> for this component to start working.
 <!--T:4-->
 == Examples ==
+{{stub}}
 <!--T:5-->
 == Related Components ==
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Mirror Transform]]
 [[Category:Components:Transform:Drivers{{#translation:}}|Mirror Transform]]