C# Class FlatRedBall.Gui.TimeLine

Inheritance: NS004.c000068

Private Properties

Property	Type	Description
CreateScrollBar	void
DestroyScrollBar	void
DrawSelfAndChildren	void
FixStartAndCurrentValue	void
GetNumberOfVerticesToDraw	int
PositionBarDrag	void
ScrollBarChanged	void
SetBarToValue	void
UpdateIncrementValueCache	void
UpdatePositionBarVisibility	void
UpdatePositionBarYValues	void
UpdateScrollBarToRange	void

Method	Description
AutoCalculateVerticalLineSpacing ( ) : void	Automatically sets the VerticalBarIncrement and SmallVerticalBarIncrement based off of the ValueWidth property.
CallOnGUIChange ( ) : void	Raises the events which raise when the GUI changes.
ClearEvents ( ) : void	Clears all events.
FixBar ( ) : void	Keeps the position bar within the visible range of the TimeLine.
TestCollision ( Cursor cursor ) : void
TimeLine ( Cursor cursor ) : System	Creates a new TimeLine;
TimeLine ( GuiSkin guiSkin, Cursor cursor ) : System	Creates a new TimeLine using the argument GuiSkin to control the visible representation.

Method	Description
ClickEvent ( Window callingWindow ) : void	Method raised when the user clicks on the Window. This moves the position bar to the appropriate location.
GetPosOnBar ( double valueToGet ) : double	Converts an absolute value to visible position on the bar
PositionToValueAbsolute ( float pos ) : double	Returns the precision-adjusted value of the time line given an absolute position.
PositionToValueRelative ( float worldUnitRelativeX ) : double	Converts the argument relative-to-TimeLine argument to a value that it represents. This mehod is used to convert the position bar's relative X to an actual value.
ValueToPositionRelative ( double value ) : float	Converts the value to the corresponding relative X position on the timeline.

Method	Description
CreateScrollBar ( ) : void
DestroyScrollBar ( ) : void
DrawSelfAndChildren ( Camera camera ) : void
FixStartAndCurrentValue ( ) : void
GetNumberOfVerticesToDraw ( ) : int
PositionBarDrag ( Window callingWindow ) : void
ScrollBarChanged ( Window callingWindow ) : void
SetBarToValue ( ) : void
UpdateIncrementValueCache ( float largeIncrementValues ) : void
UpdatePositionBarVisibility ( ) : void
UpdatePositionBarYValues ( ) : void
UpdateScrollBarToRange ( ) : void

Automatically sets the VerticalBarIncrement and SmallVerticalBarIncrement based off of the ValueWidth property.

public AutoCalculateVerticalLineSpacing ( ) : void
return	void

Raises the events which raise when the GUI changes.

public CallOnGUIChange ( ) : void
return	void

Clears all events.

public ClearEvents ( ) : void
return	void

Method raised when the user clicks on the Window. This moves the position bar to the appropriate location.

protected ClickEvent ( Window callingWindow ) : void
callingWindow	Window	The window raising this event.
return	void

Keeps the position bar within the visible range of the TimeLine.

public FixBar ( ) : void
return	void

Converts an absolute value to visible position on the bar

protected GetPosOnBar ( double valueToGet ) : double
valueToGet	double	The absolute value to convert to position.
return	double

Returns the precision-adjusted value of the time line given an absolute position.

protected PositionToValueAbsolute ( float pos ) : double
pos	float	The absolute X position.
return	double

Converts the argument relative-to-TimeLine argument to a value that it represents.

This mehod is used to convert the position bar's relative X to an actual value.

protected PositionToValueRelative ( float worldUnitRelativeX ) : double
worldUnitRelativeX	float	The relative-to-Timeline position.
return	double

public TestCollision ( Cursor cursor ) : void
cursor	Cursor
return	void

Creates a new TimeLine;

public TimeLine ( Cursor cursor ) : System
cursor	Cursor	The Cursor that will interact with the TimeLine.
return	System

Creates a new TimeLine using the argument GuiSkin to control the visible representation.

public TimeLine ( GuiSkin guiSkin, Cursor cursor ) : System
guiSkin	GuiSkin	The GuiSkin to use.
cursor	Cursor	The Cursor that will interact with the TimeLine.
return	System

Converts the value to the corresponding relative X position on the timeline.

protected ValueToPositionRelative ( double value ) : float
value	double	The value to convert to a relative position.
return	float