Component:SnapLine

CollapseComponent image 

Snap Line component as seen in the Scene Inspector

A snap line is a component that is able to generate a point in a line 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) When provided a point, it finds the closest point on a line and returns that 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 Collapse

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.
Point0	Float3	The first point to use to define the line
Point1	Float3	the second point to define the line
Anchor0	Slot	an override to use instead of Point0 to define the line
Anchor1	Slot	an override to use instead of Point1 to define the line
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 drawing tools.