Camera Path Animator – Camera Path Component Code

CameraPath.RemovePoint

Method Void RemovePoint ( CameraPathControlPoint point )
Description

Remove a point from the path by specify the point to remove

point : The point you want to remove
CameraPath.GetPointNumber

Method int GetPointNumber ( float percentage )
Description

Get the index of a point at the start of a curve based on path percentage

percentage : Path Percent 0-1
returns: Index of point
CameraPath.GetPathPosition

Method Vector3 GetPathPosition ( float percentage )
Description

Get a position based on a percent of the path specifying the result will be normalised or not

percentage : Path Percent 0-1
returns: Path Postion
CameraPath.GetPathPosition

Method Vector3 GetPathPosition ( float percentage, bool ignoreNormalisation )
Description

Get a position based on a percent of the path specifying the result will be normalised or not

percentage : Path Percent 0-1
ignoreNormalisation : Should we ignore path normalisation
returns: Path Postion
CameraPath.GetPathDirection

Method Vector3 GetPathDirection ( float percentage )
Description

Retrive a path direction from stored values

percentage : Path Percent 0-1
returns: The direction of the path at this percent
CameraPath.GetPathDirection

Method Vector3 GetPathDirection ( float percentage, bool normalisePercent )
Description

Retrive a path direction from stored values

percentage : Path Percent 0-1
normalisePercent : Should we normalise the result
returns: The direction of the path at this percent
CameraPath.GetPathFOV

Method float GetPathFOV ( float percentage )
Description

Get the Field of View value from the path FOV list based on a percentage

percentage : The path percentage (0-1)
returns: A field of view value
CameraPath.GetPathSpeed

Method float GetPathSpeed ( float percentage )
Description

Get the Speed value from the path based on a path percent

percentage : The path parcent point you wish to sample (0-1)
returns: A speed value
CameraPath.GetPathEase

Method float GetPathEase ( float percentage )
Description

Get the animation ease value at a specific point on the path

percentage : The percent point you wish to sample from (0-1)
returns: An ease value
CameraPath.CheckEvents

Method Void CheckEvents ( float percentage )
Description

Check the event list for any events that should have been fired since last call

percentage : The current path percent 0-1
CameraPath.GetNearestPointIndex

Method int GetNearestPointIndex ( float percentage )
Description

Get the index of a point nearest to the specifiec percent

percentage : The path percent (0-1)
returns: An index of a path point
CameraPath.GetLastPointIndex

Method int GetLastPointIndex ( float percentage, bool isNormalised )
Description

Get the point index value based on a percent value

percentage : The path percentage point
isNormalised : Should the percentage be normalised
returns: The previous point on the Path
CameraPath.GetNextPointIndex

Method int GetNextPointIndex ( float percentage, bool isNormalised )
Description

Get the point index value based on a percent value

percentage : The path percentage point
isNormalised : Should the percentage be normalised
returns: The next point on the Path
CameraPath.GetStoredPoint

Method int GetStoredPoint ( float percentage )
Description

Get a precalculated point inbex based on the path percentage

percentage : Percentage point on path (0-1)
returns: The index of a staored point
CameraPath.RecalculateStoredValues

Method Void RecalculateStoredValues ( )
Description

Calculate stored values that camera path uses
Mostly this is used to establish a normalised curve so speed can be maintained.
A few other functions are completed too like assigning values to points like name

CameraPath.Clear

Method Void Clear ( )
Description

Clear the path of points

CameraPath.GetPoint

Method CameraPathControlPoint GetPoint ( int index )
Description

Get a path point by specifing an index
Looping, out of range indicies are properly handled

index : The point index
returns: The path point
CameraPath.GetPointIndex

Method int GetPointIndex ( int index )
Description

Get a path point index by specifing an index
Looping, out of range indicies are properly handled

index : The point index
returns: The path point index
CameraPath.GetCurveIndex

Method int GetCurveIndex ( int startPointIndex )
Description

Get the curve index based on a point index

startPointIndex : The first point on the curve
returns: The curve index
CameraPath.ToXML

Method string ToXML ( )
Description

Convert this camera path into an xml string for export

returns: A generated XML string
CameraPath.FromXML

Method Void FromXML ( string XMLPath )
Description

Import XML data into this camera path overwriting the current data

XMLPath : An XML file path

Comments are closed.