Component:SnapPlane: Difference between revisions

Revision as of 19:00, 29 February 2024

Component image

**Snap Plane** component as seen in the Scene Inspector

A snap plane is a component that is able to generate a point in a plane shape when given a point by another component. Usually this is used in components like the Multi User Avatar Anchor Component to determine where to place the anchors upon clicking (click point is used in such case). This component will take a given point by another component and find the closest surface point to a plane with a normal + with a center positioned at the slot it is on. This component will then return the point to the component that called it.

The functionality of this component is internal, and cannot be used by ProtoFlux to snap points using in game code.

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.
`Normal`	Float3	Determines which direction the plane is facing
`SnapParent`	Slot	Where to put slots if the component is being used for slot placement.

Usage

Used as an anchor point generator in the Multi User Avatar Anchor Component and other components.

Examples

Related Components

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=SnapPlaneComponent.png
 |Name=Snap Plane
 }}
+A snap plane is a component that is able to generate a point in a plane shape when given a point by another component. Usually this is used in components like the [[Component:MultiUserAvatarAnchor|Multi User Avatar Anchor Component]] to determine where to place the anchors upon clicking (click point is used in such case). This component will take a given point by another component and find the closest surface point to a plane with a normal + with a center positioned at the slot it is on. This component will then return the point to the component that called it.
+The functionality of this component is internal, and cannot be used by [[ProtoFlux]] to snap points using in game code.
 <!--T:2-->
 == Fields ==
 {{Table ComponentFields
-|Normal|Float3|
+|Normal|Float3| Determines which direction the plane is facing
-|SnapParent|Slot|
+|SnapParent|Slot| Where to put slots if the component is being used for slot placement.
 }}
 <!--T:3-->
 == Usage ==
+Used as an anchor point generator in the [[Component:MultiUserAvatarAnchor|Multi User Avatar Anchor Component]] and other components.
 <!--T:4-->
@@ Line 24: / Line 28: @@
 == Related Components ==
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Snap Plane]]
 [[Category:Components:Transform:Snapping{{#translation:}}|Snap Plane]]