Inheritance diagram for AC.DragTrack:

Public Member Functions
virtual bool	TypeSupportsSnapConnections ()

virtual float	GetDecimalAlong (Moveable_Drag draggable)
	Gets the proportion along the track that an object is positioned. More...

virtual void	SetPositionAlong (float proportionAlong, Moveable_Drag draggable)
	Positions an object on a specific point along the track. More...

virtual void	Connect (Moveable_Drag draggable)
	Connects an object to the track when the game begins. More...

void	OnDisconnect (Moveable_Drag draggable)
	Called when an object attached to the track is disconnected from it. More...

virtual void	ApplyDragForce (Vector3 force, Moveable_Drag draggable)
	Applies a force to an object connected to the track. More...

virtual float	GetScreenPointProportionAlong (Vector2 point, Vector3 grabRelativePosition, Moveable_Drag drag)
	Gets the proportion along the track closest to a given position in screen-space More...

float	GetMinDistanceToScreenPoint (Vector2 point)
	Gets the smallest distance, in screen-space, between a given position in screen space, and the point on the track that it is closest to. More...

virtual void	ApplyAutoForce (float _position, float _speed, Moveable_Drag draggable, bool ignoreMaxSpeed)
	Applies a force that, when applied every frame, pushes an object connected to the track towards a specific point along it. More...

virtual void	UpdateDraggable (Moveable_Drag draggable)
	Updates the position of an object connected to the track. This is called every frame. More...

void	OnLetGo (Moveable_Drag draggable)
	Called whenever an object attached to the track is let go by the player More...

virtual void	SnapToTrack (Moveable_Drag draggable, bool onStart)
	Corrects the position of an object so that it is placed along the track. More...

virtual bool	IconIsStationary ()
	Checks if the icon that can display when an object is moved along the track remains in the same place as the object moves. More...

virtual Vector3	GetGizmoPosition (float proportionAlong)
	Gets the position of gizmos at a certain position along the track More...

virtual Vector3	GetForceToPosition (Moveable_Drag draggable, float targetProportionAlong)
	Calculates a force to get a draggable object to a given point along the track More...

virtual float	GetMoveSoundIntensity (float deltaTrackPosition)

TrackSnapData	GetSnapData (int regionID)
	Gets TrackSnapData for a snap point More...

float	GetRegionPositionAlong (int regionID)
	Gets the position along the track for the centre of a given region More...

bool	IsWithinTrackRegion (float trackValue, int regionID)
	Checks if a position along the track is within a given track region More...

virtual float	GetForceDotProduct (Vector3 force, Moveable_Drag draggable)

Public Attributes
PhysicMaterial	colliderMaterial

float	discSize = 0.2f

Color	handleColour = Color.white

DragMovementCalculation	dragMovementCalculation = DragMovementCalculation.DragVector

bool	doSnapping = false

List< TrackSnapData >	allTrackSnapData = new List<TrackSnapData>()

float	snapSpeed = 100f

bool	onlySnapOnPlayerRelease

bool	preventEndToEndJumping = false

ActionListSource	actionListSource = ActionListSource.InScene

Protected Member Functions
void	DoRegionAudioCheck (Moveable_Drag draggable)

virtual void	AssignColliders (Moveable_Drag draggable)

void	DoSnapCheck (Moveable_Drag draggable)

void	DoConnectionCheck (Moveable_Drag draggable)

void	SnapToNearest (Moveable_Drag draggable)

void	LimitCollisions (Moveable_Drag draggable)

Vector3	RotatePointAroundPivot (Vector3 point, Vector3 pivot, Quaternion rotation)

Properties
virtual bool	Loops `[get]`

virtual bool	UsesEndColliders `[get]`

Transform	Transform `[get]`

Detailed Description

The base class for "tracks", which are used to contrain Moveable_Drag objects along a pre-determined path

Member Function Documentation

◆ ApplyAutoForce()

virtual void AC.DragTrack.ApplyAutoForce	(	float	_position,
		float	_speed,
		Moveable_Drag	draggable,
		bool	ignoreMaxSpeed
	)

virtual

Applies a force that, when applied every frame, pushes an object connected to the track towards a specific point along it.

Parameters

_position	The proportion along which to place the Moveable_Drag object (0 to 1)
_speed	The speed to move by
draggable	The draggable object to move
ignoreMaxSpeed	If False, the object's maxSpeed will limit the speed

Reimplemented in AC.DragTrack_Straight, AC.DragTrack_Curved, and AC.DragTrack_Hinge.

◆ ApplyDragForce()

virtual void AC.DragTrack.ApplyDragForce	(	Vector3	force,
		Moveable_Drag	draggable
	)

virtual

Applies a force to an object connected to the track.

Parameters

force	The drag force vector input by the player
draggable	The Moveable_Drag object to apply the force to

Reimplemented in AC.DragTrack_Straight, AC.DragTrack_Hinge, and AC.DragTrack_Curved.

◆ Connect()

virtual void AC.DragTrack.Connect ( Moveable_Drag draggable )

virtual

Connects an object to the track when the game begins.

Parameters

draggable The Moveable_Drag object to connect to the track

Reimplemented in AC.DragTrack_Curved, AC.DragTrack_Straight, and AC.DragTrack_Hinge.

◆ GetDecimalAlong()

virtual float AC.DragTrack.GetDecimalAlong ( Moveable_Drag draggable )

virtual

Gets the proportion along the track that an object is positioned.

Parameters

draggable The Moveable_Drag object to check the position of

Returns: The proportion along the track that the Moveable_Drag object is positioned (0 to 1)

Reimplemented in AC.DragTrack_Hinge, AC.DragTrack_Curved, and AC.DragTrack_Straight.

◆ GetForceToPosition()

virtual Vector3 AC.DragTrack.GetForceToPosition	(	Moveable_Drag	draggable,
		float	targetProportionAlong
	)

virtual

Calculates a force to get a draggable object to a given point along the track

Parameters

draggable	The draggable object
targetProportionAlong	How far along the track to calculate a force for

Returns: The force vector, in world space

Reimplemented in AC.DragTrack_Hinge, AC.DragTrack_Curved, and AC.DragTrack_Straight.

◆ GetGizmoPosition()

virtual Vector3 AC.DragTrack.GetGizmoPosition ( float proportionAlong )

virtual

Gets the position of gizmos at a certain position along the track

Parameters

proportionAlong The proportio along the track to get the gizmo position of

Returns: The position of the gizmo

Reimplemented in AC.DragTrack_Hinge, AC.DragTrack_Curved, and AC.DragTrack_Straight.

◆ GetMinDistanceToScreenPoint()

float AC.DragTrack.GetMinDistanceToScreenPoint ( Vector2 point )

Gets the smallest distance, in screen-space, between a given position in screen space, and the point on the track that it is closest to.

Parameters

point The point, in screen space

Returns: The smallest distance, in screen-space, between a given position in screen space, and the point on the track that it is closest to.

◆ GetRegionPositionAlong()

float AC.DragTrack.GetRegionPositionAlong ( int regionID )

Gets the position along the track for the centre of a given region

Parameters

regionID The ID of the region to get the position of

Returns: The centre-point position along the track of the region

◆ GetScreenPointProportionAlong()

virtual float AC.DragTrack.GetScreenPointProportionAlong	(	Vector2	point,
		Vector3	grabRelativePosition,
		Moveable_Drag	drag
	)

virtual

Gets the proportion along the track closest to a given position in screen-space

Parameters

point	The position in screen-space
grabRelativePosition	The grab position relative to the draggable's centre
dragm	The object being dragged

Returns: The proportion along the track closest to a given position in screen-space

Reimplemented in AC.DragTrack_Straight, AC.DragTrack_Hinge, and AC.DragTrack_Curved.

◆ GetSnapData()

TrackSnapData AC.DragTrack.GetSnapData ( int regionID )

Gets TrackSnapData for a snap point

Parameters

regionID The ID of the region to get data for

Returns: The TrackSnapData associated with the given ID

◆ IconIsStationary()

virtual bool AC.DragTrack.IconIsStationary ( )

virtual

Checks if the icon that can display when an object is moved along the track remains in the same place as the object moves.

Returns: True if the icon remains in the same place (always False unless overridden by subclasses)

Reimplemented in AC.DragTrack_Straight.

◆ IsWithinTrackRegion()

bool AC.DragTrack.IsWithinTrackRegion	(	float	trackValue,
		int	regionID
	)

Checks if a position along the track is within a given track region

Parameters

trackValue	The distance along the track, as a decimal of its total length
snapID	The ID number of the snap region

Returns: True if the position along the track is within the region</region>

◆ OnDisconnect()

void AC.DragTrack.OnDisconnect ( Moveable_Drag draggable )

Called when an object attached to the track is disconnected from it.

Parameters

draggable The Moveable_Drag object being disconnected from the track

◆ OnLetGo()

void AC.DragTrack.OnLetGo ( Moveable_Drag draggable )

Called whenever an object attached to the track is let go by the player

Parameters

draggable The draggable object

◆ SetPositionAlong()

virtual void AC.DragTrack.SetPositionAlong	(	float	proportionAlong,
		Moveable_Drag	draggable
	)

virtual

Positions an object on a specific point along the track.

Parameters

proportionAlong	The proportion along which to place the Moveable_Drag object (0 to 1)
draggable	The Moveable_Drag object to reposition

Reimplemented in AC.DragTrack_Hinge, AC.DragTrack_Curved, and AC.DragTrack_Straight.

◆ SnapToTrack()

virtual void AC.DragTrack.SnapToTrack	(	Moveable_Drag	draggable,
		bool	onStart
	)

virtual

Corrects the position of an object so that it is placed along the track.

Parameters

draggable	The Moveable_Drag object to snap onto the track
onStart	Is True if the game has just begun (i.e. this function is being run for the first time)

Reimplemented in AC.DragTrack_Hinge, AC.DragTrack_Curved, and AC.DragTrack_Straight.

◆ TypeSupportsSnapConnections()

virtual bool AC.DragTrack.TypeSupportsSnapConnections ( )

virtual

Returns true if this type of track supports connections with other tracks via snapping

Reimplemented in AC.DragTrack_Curved, and AC.DragTrack_Straight.

◆ UpdateDraggable()

virtual void AC.DragTrack.UpdateDraggable ( Moveable_Drag draggable )

virtual

Updates the position of an object connected to the track. This is called every frame.

Parameters

draggable The Moveable_Drag object to update the position of

Reimplemented in AC.DragTrack_Hinge, AC.DragTrack_Curved, and AC.DragTrack_Straight.

Member Data Documentation

◆ actionListSource

ActionListSource AC.DragTrack.actionListSource = ActionListSource.InScene

Where to locate interactions

◆ allTrackSnapData

List<TrackSnapData> AC.DragTrack.allTrackSnapData = new List<TrackSnapData>()

A list of all the points along the track that attached objects can snap to, if doSnapping = True

◆ colliderMaterial

PhysicMaterial AC.DragTrack.colliderMaterial

The Physics Material to give the track's end colliders

◆ discSize

float AC.DragTrack.discSize = 0.2f

The size of the track's end colliders, as seen in the Scene window

◆ doSnapping

bool AC.DragTrack.doSnapping = false

If True, then snapping is enabled and any object attached to the track can snap to pre-set points along it when let go by the player

◆ dragMovementCalculation

DragMovementCalculation AC.DragTrack.dragMovementCalculation = DragMovementCalculation.DragVector

How input movement is calculated (DragVector, CursorPosition)

◆ handleColour

Color AC.DragTrack.handleColour = Color.white

The colour of Scene window Handles

◆ onlySnapOnPlayerRelease

bool AC.DragTrack.onlySnapOnPlayerRelease

If True, then snapping will only occur when the player releases the object - and not when moving on its own accord

◆ preventEndToEndJumping

bool AC.DragTrack.preventEndToEndJumping = false

If True, and the track doesn't loop, then the dragged object will be prevented from jumping from one end to the other without first moving somewhere in between

◆ snapSpeed

float AC.DragTrack.snapSpeed = 100f

The speed to move by when attached objects snap

Property Documentation

◆ Loops

virtual bool AC.DragTrack.Loops

get

Checks if the track is on a loop

◆ Transform

Transform AC.DragTrack.Transform

get

A cache of the tracks's transform component

◆ UsesEndColliders

virtual bool AC.DragTrack.UsesEndColliders

get

If True, end-colliders are generated to prevent draggable objects from leaving the track's boundaries

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ApplyAutoForce()

◆ ApplyDragForce()

◆ Connect()

◆ GetDecimalAlong()

◆ GetForceToPosition()

◆ GetGizmoPosition()

◆ GetMinDistanceToScreenPoint()

◆ GetRegionPositionAlong()

◆ GetScreenPointProportionAlong()

◆ GetSnapData()

◆ IconIsStationary()

◆ IsWithinTrackRegion()

◆ OnDisconnect()

◆ OnLetGo()

◆ SetPositionAlong()

◆ SnapToTrack()

◆ TypeSupportsSnapConnections()

◆ UpdateDraggable()

Member Data Documentation

◆ actionListSource

◆ allTrackSnapData

◆ colliderMaterial

◆ discSize

◆ doSnapping

◆ dragMovementCalculation

◆ handleColour

◆ onlySnapOnPlayerRelease

◆ preventEndToEndJumping

◆ snapSpeed

Property Documentation

◆ Loops

◆ Transform

◆ UsesEndColliders