Passer.InteractionPointer Class Reference

Description

A generic pointer to interact with objects in the scene using the Unity Event system.

The interaction pointer is a generic pointer to interact with objects in the scene using the Unity Event system or InteractionEvents. The objects can receive and react on these interactions when an Unity Event Trigger component has been added to them. The Teleporter is an specific implementation of an Interaction Pointer.

Setup

An interaction pointer can be added to any object. The objects Transform determines the starting position of the pointer and the pointer will always point in the direction of the Transform Forward.

Configuration

• Active
• Timed Click
• Focus Point Object
• Object in Focus
• Mode

Straight Cast

The straight mode will cast a ray from the Transform position in the forward direction until it hits an object.

Bezier Cast

In bezier mode, a curve will be cast from the Transform position in the forward direction. The distance reached by this curve is limited. The curve is determine by the following parameters:

• Maximum Distance: this determines the maximum distance in units you can reach with the curve
• Resolution: the number of segments in the curve. Higher gives a smoother curve but requires more performance.

Gravity Cast

In gravity mode, a curve will be cast from the Transform position in the forward direction. This curve follows a gravity path as if an object is launched. The curve can be configured with the following parameters:

• Maximum Distance: the maximum length of the curve in units.
• Resolution: the number of segments of the curve. Higher gives are smoother curve but requires more performance.
• Speed: the horizontal speed determining the curve. A higher value can reach further positions.

Sphere Cast

Is similar to the Straight mode, but casts a sphere instead of a ray. It has the following configuration parameters:

• Maximum Distance: the distance the sphere is case.
• Radius: the radius of the sphere.

Focus Point Object

The Focus Point Object is disabled or enabled automatically when the Interaction Pointer is activated or deactivated. The Transform of the target point object will be updated based on the ray curve to match the focus point of the Interaction Pointer. It will be aligned with the normal of the surface. This object can be used to show the focus point of the interaction pointer in the way you like.

Line Renderer

When an line renderer is attached to the Focus Point Object, it will automatically be updated to show the line ray casting curve. You can change this line render to your likings. Only the positions will be overwritten when the Interaction Pointer is active.

Events

• Active Event
• Click Event
• Focus Event

Event System Compatibility

The following event of the Event System are currently supported:

• PointerDown: is sent to the object in focus when the click starts
• PointerUp: is sent to the object in focus when the click ends
• PointerClick: is sent to the object when a click has been completed
• PointerEnter: is sent to an object when it comes into focus of the Interaction Pointer
• PointerExit: is sent to an object when it no longer is in focus of the Interaction Pointer
• BeginDrag: is sent to the object in focus when a click has started and the focus point starts to move
• Drag: is sent to the object in focus while the focus point changes during a click
• EndDrag: is sent to the object in focus when the click ends after the focus point started to move

Inheritance diagram for Passer.InteractionPointer:

Public Types
enum	RayType { Straight , Bezier , Gravity , SphereCast }
	The ray modes for interaction pointers.
enum	PointerType { FocusPoint , Ray }
	The type of interaction pointer.

Public Member Functions
void	PointTo (GameObject obj)
void	SetDirection (Vector3 lookDirection)
void	LaunchRigidbody (Rigidbody rigidbody)
void	LaunchPrefab (GameObject prefab)
void	SpawnOnObjectInFocus (GameObject prefab)
	Spawns a prefab as a child of the objectInFocus.
void	ApplyForce (float magnitude)
void	FullClick ()
	Click on the objectInFocus.
virtual void	Click (bool clicking=true)
	Change the click status on the objectInFocus.
virtual void	Activation (bool _active)
	Change the active status of the InteractionPointer.
virtual void	ActivateClick (bool _active)

Static Public Member Functions
static InteractionPointer	Add (Transform parentTransform, PointerType pointerType=PointerType.Ray)
	Adds a default InteractionPointer to the transform.

Public Attributes
bool	active = true
	Is the interaction pointer active?
float	timedClick
	Automatically initiates a click when the objectInFocus does not change for the set amount of seconds.
GameObject	focusPointObj
	The GameObject which represents the focus point of the Interaction Pointer when it is active.
GameObject	objectInFocus
	The object to which the Interaction Pointer is pointing at.
float	focusDistance
	Distance to the objectInFocus.
RayType	rayType = RayType.Straight
	The ray mode for this interaction pointer.
float	maxDistance = 10
	The maximum length of the curve in units(meters)
float	resolution = 0.2F
	The size of a segment in the curve.
float	speed = 3
	The horizontal speed for a gravity curve.
float	radius = 0.1F
	The radius of the sphere in a SphereCast.
GameObjectEventHandlers	focusEvent
	Event based on the current focus.
Vector3EventList	focusPointEvent
	Event based on the current focus.
GameObjectEventHandlers	clickEvent
	Event based on the clicking status.
BoolEvent	activeEvent = new BoolEvent()
	Event based on the active status.

Protected Member Functions
virtual void	Awake ()
virtual InteractionModule	CreateInteractionModule ()
virtual EventSystem	CreateEventSystem ()
virtual void	Start ()
virtual void	Update ()
virtual void	UpdateStraight ()
virtual void	UpdateBezier ()
virtual Vector3[]	UpdateBezierCurve (Transform transform, float maxDistance, out Vector3 normal, out GameObject focusObject)
Vector3	GetPoint (float t, Transform transform)
Vector3	GetVelocity (float t, Transform transform)
virtual void	UpdateGravity ()
virtual void	UpdateGravityCurve (Transform transform, float forwardSpeed, out Vector3 normal, out GameObject hitObject)
virtual void	UpdateSpherecast ()
virtual void	UpdateFocus ()
void	UpdateFocusPoint ()
virtual void	OnDrawGizmosSelected ()

Static Protected Member Functions
static void	DebugLog (string s)

Protected Attributes
bool	hasClicked = false
InteractionModule	interactionModule
int	interactionID
InteractionModule.InteractionPointer	interactionPointer
LineRenderer	lineRenderer
	The LineRender for this pointer when available.
float	focusTimeToTouch = 0
float	focusStart = 0
float	heightLimitAngle = 100f
Vector3	startPosition = Vector3.zero
Vector3	intermediatePosition
Vector3	endPosition
GameObject	previousObjectInFocus

Member Function Documentation

Add()

static InteractionPointer Passer.InteractionPointer.Add ( Transform  parentTransform, PointerType  pointerType = PointerType::Ray  )

static

Adds a default InteractionPointer to the transform.

Parameters

parentTransform	The transform to which the Teleporter will be added
pointerType	The interaction pointer type for the Teleporter.

SpawnOnObjectInFocus()

void Passer.InteractionPointer.SpawnOnObjectInFocus

(

GameObject

prefab

)

Spawns a prefab as a child of the objectInFocus.

Parameters

prefab

The prefab to spawn

The spawn position and rotation will match the focusPoint transform. When the objectInFocus is null, the prefab will be spawned as a root transform.

FullClick()

void Passer.InteractionPointer.FullClick

(

)

Click on the objectInFocus.

This function will do a full click: a button down followed by a button up.

Click()

virtual void Passer.InteractionPointer.Click ( bool  clicking = true )

virtual

Change the click status on the objectInFocus.

Parameters

clicking

Indicates if the button is down

Reimplemented in Passer.Teleporter.

Activation()

virtual void Passer.InteractionPointer.Activation ( bool  _active )

virtual

Change the active status of the InteractionPointer.

Parameters

_active

Indicates if the InteractionPointer is active

Member Data Documentation

active

bool Passer.InteractionPointer.active = true

Is the interaction pointer active?

When an interaction pointer is active, it will actively point to objects. The objectInFocus will be updated based on the pointer. When a focusPointObj is set, this object will be set active. When a Line Renderer is set, the line renderer will be updated according to the properties of the pointer.

timedClick

float Passer.InteractionPointer.timedClick

Automatically initiates a click when the objectInFocus does not change for the set amount of seconds.

The value 0 disables this function.

focusPointObj

GameObject Passer.InteractionPointer.focusPointObj

The GameObject which represents the focus point of the Interaction Pointer when it is active.

If this is set and the pointer is active, the object will be objected based on the pointer's properties This GameObject will be disabled when the pointer is not active.

objectInFocus

GameObject Passer.InteractionPointer.objectInFocus

The object to which the Interaction Pointer is pointing at.

This is updated at runtime while the pointer is active. The value is null when the pointer is not reaching any object.

focusDistance

float Passer.InteractionPointer.focusDistance

Distance to the objectInFocus.

This is float.infintiy when no object is in focus

maxDistance

float Passer.InteractionPointer.maxDistance = 10

The maximum length of the curve in units(meters)

This value is used for Straight, SphereCast and Bezier RayTypes

resolution

float Passer.InteractionPointer.resolution = 0.2F

The size of a segment in the curve.

Lower values will give a smoother curve, but requires more performance This value is used for Bezier and Gravity RayTypes

speed

float Passer.InteractionPointer.speed = 3

The horizontal speed for a gravity curve.

A higher speed will reach further positions.

focusEvent

GameObjectEventHandlers Passer.InteractionPointer.focusEvent

Initial value:

= new GameObjectEventHandlers() {
            label = "Focus Event",
            tooltip =
                "Call functions using the current focus\n" +
                "Parameter: the Object in Focus"
        }

Event based on the current focus.

This event is generated from the objectInFocus. It has the objectInFocus as parameter. It can be used to execute functions when the focus changes between objects.

focusPointEvent

Vector3EventList Passer.InteractionPointer.focusPointEvent

Initial value:

= new Vector3EventList() {
            label = "Focus Point Event",
            tooltip =
                "Call functions using the current focus point\n" +
                "Parameter: the position of the focus point"
        }

Event based on the current focus.

This event is generated from the objectInFocus. It has the objectInFocus as parameter. It can be used to execute functions when the focus changes between objects.

clickEvent

GameObjectEventHandlers Passer.InteractionPointer.clickEvent

Initial value:

= new GameObjectEventHandlers() {
            label = "Click Event",
            tooltip =
                "Call functions using the clicking status\n" +
                "Parameter: the Object in Focus when clicking"
        }

Event based on the clicking status.

This event is generated from the clicking boolean. It has the objectInFocus as parameter. It can be used to exectue functions when the user has clicked on an object.

activeEvent

BoolEvent Passer.InteractionPointer.activeEvent = new BoolEvent()

Event based on the active status.

This event is genereated from the active boolean Is has the active boolean as parameter. It can be used to execute functions when the interaction pointer is activated.

---

The documentation for this class was generated from the following file:

• d:/Unity/Humanoid4/Humanoid4_Pro/Assets/humanoidcontrol4_pro/Runtime/Tools/Scripts/InteractionPointer.cs