Component:SnapCircle

CollapseComponent image 

Snap Circle component as seen in the Scene Inspector

A snap circle is a component that is able to generate a point on a circle along a plane 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 circle and normal 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.
Radius	Float	How big the circle should be
Normal	Float3	which direction the circle should face
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.