Inheritance diagram for AC.DragTrack_Straight:

Public Member Functions
override bool	TypeSupportsSnapConnections ()
override void	Connect (Moveable_Drag draggable)
	Connects an object to the track when the game begins.
override float	GetDecimalAlong (Moveable_Drag draggable)
	Gets the proportion along the track that an object is positioned.
override void	SetPositionAlong (float proportionAlong, Moveable_Drag draggable)
	Positions an object on a specific point along the track.
override void	SnapToTrack (Moveable_Drag draggable, bool onStart)
	Corrects the position of an object so that it is placed along the track.
override 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.
override float	GetForceDotProduct (Vector3 force, Moveable_Drag draggable)
override void	ApplyDragForce (Vector3 force, Moveable_Drag draggable)
	Applies a force to an object connected to the track.
override float	GetScreenPointProportionAlong (Vector2 point, Vector3 grabRelativePosition, Moveable_Drag drag)
	Gets the proportion along the track closest to a given position in screen-space.
override 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.
override void	UpdateDraggable (Moveable_Drag draggable)
	Updates the position of an object connected to the track. This is called every frame.
override Vector3	GetGizmoPosition (float proportionAlong)
	Gets the position of gizmos at a certain position along the track.
override Vector3	GetForceToPosition (Moveable_Drag draggable, float targetProportionAlong)
	Calculates a force to get a draggable object to a given point along the track.
override float	GetMoveSoundIntensity (float deltaTrackPosition)
Public Member Functions inherited from AC.DragTrack
void	OnDisconnect (Moveable_Drag draggable)
	Called when an object attached to the track is disconnected from it.
float	GetMinDistanceToScreenPoint (Vector2 point, Moveable_Drag drag)
	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.
void	OnLetGo (Moveable_Drag draggable)
	Called whenever an object attached to the track is let go by the player.
TrackSnapData	GetSnapData (int regionID)
	Gets TrackSnapData for a snap point.
float	GetRegionPositionAlong (int regionID)
	Gets the position along the track for the centre of a given region.
bool	IsWithinTrackRegion (float trackValue, int regionID)
	Checks if a position along the track is within a given track region.

Public Attributes
DragRotationType	rotationType = DragRotationType.None
float	maxDistance = 2f
bool	dragMustScrew = false
float	screwThread = 1f
bool	generateColliders = true
Public Attributes inherited from AC.DragTrack
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
override void	AssignColliders (Moveable_Drag draggable)
void	SetRotation (Moveable_Drag draggable, float proportionAlong)
Protected Member Functions inherited from AC.DragTrack
void	DoRegionAudioCheck (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
override bool	UsesEndColliders `[get]`
Properties inherited from AC.DragTrack
virtual bool	Loops `[get]`
virtual bool	UsesEndColliders `[get]`
Transform	Transform `[get]`

Detailed Description

A track that constrains a Moveable_Drag object along a straight line. The dragged object can also be made to rotate as it moves: either so it rolls, or rotates around the line's axis (like a screw).

Member Function Documentation

◆ ApplyAutoForce()

override void AC.DragTrack_Straight.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 from AC.DragTrack.

◆ ApplyDragForce()

override void AC.DragTrack_Straight.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 from AC.DragTrack.

◆ AssignColliders()

override void AC.DragTrack_Straight.AssignColliders ( Moveable_Drag draggable )

protectedvirtual

Reimplemented from AC.DragTrack.

◆ Connect()

override void AC.DragTrack_Straight.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 from AC.DragTrack.

◆ GetDecimalAlong()

override float AC.DragTrack_Straight.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 from AC.DragTrack.

◆ GetForceDotProduct()

override float AC.DragTrack_Straight.GetForceDotProduct	(	Vector3	force,
		Moveable_Drag	draggable )

virtual

Reimplemented from AC.DragTrack.

◆ GetForceToPosition()

override Vector3 AC.DragTrack_Straight.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 from AC.DragTrack.

◆ GetGizmoPosition()

override Vector3 AC.DragTrack_Straight.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 from AC.DragTrack.

◆ GetMoveSoundIntensity()

override float AC.DragTrack_Straight.GetMoveSoundIntensity ( float deltaTrackPosition )

virtual

Reimplemented from AC.DragTrack.

◆ GetScreenPointProportionAlong()

override float AC.DragTrack_Straight.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
drag	The object being dragged

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

Reimplemented from AC.DragTrack.

◆ IconIsStationary()

override bool AC.DragTrack_Straight.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 from AC.DragTrack.

◆ SetPositionAlong()

override void AC.DragTrack_Straight.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 from AC.DragTrack.

◆ SnapToTrack()

override void AC.DragTrack_Straight.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 from AC.DragTrack.

◆ TypeSupportsSnapConnections()

override bool AC.DragTrack_Straight.TypeSupportsSnapConnections ( )

virtual

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

Reimplemented from AC.DragTrack.

◆ UpdateDraggable()

override void AC.DragTrack_Straight.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 from AC.DragTrack.

Member Data Documentation

◆ dragMustScrew

bool AC.DragTrack_Straight.dragMustScrew = false

If True, and the Moveable_Drag object rotates like a screw, then the input drag vector must also rotate, so that it is always tangential to the dragged object

◆ generateColliders

bool AC.DragTrack_Straight.generateColliders = true

If True, then colliders will be auto-generated at the ends of the track, to add friction/bounce effects when the dragged objects reaches the limits

◆ maxDistance

float AC.DragTrack_Straight.maxDistance = 2f

The track's length

◆ rotationType

DragRotationType AC.DragTrack_Straight.rotationType = DragRotationType.None

The way in which the Moveable_Drag object rotates as it moves (None, Roll, Screw)

◆ screwThread

float AC.DragTrack_Straight.screwThread = 1f

The "thread" if the Moveable_Drag object rotates like a screw - effectively how fast the object rotates as it moves

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ApplyAutoForce()

◆ ApplyDragForce()

◆ AssignColliders()

◆ Connect()

◆ GetDecimalAlong()

◆ GetForceDotProduct()

◆ GetForceToPosition()

◆ GetGizmoPosition()

◆ GetMoveSoundIntensity()

◆ GetScreenPointProportionAlong()

◆ IconIsStationary()

◆ SetPositionAlong()

◆ SnapToTrack()

◆ TypeSupportsSnapConnections()

◆ UpdateDraggable()

Member Data Documentation

◆ dragMustScrew

◆ generateColliders

◆ maxDistance

◆ rotationType

◆ screwThread