albaGUISettingsTimeBar Class Reference

#include <albaGUISettingsTimeBar.h>

Inheritance diagram for albaGUISettingsTimeBar:

Collaboration diagram for albaGUISettingsTimeBar:

Public Types
enum	STORAGE_SETTINGS_WIDGET_ID {   ID_REAL_TIME = MINID , ID_TIME_SPEED , ID_TIME_SCALE , ID_TIME_STEP ,   ID_NUMBER_OF_FRAMES , ID_ANIMATE_IN_SUBRANGE , ID_SUBRANGE , ID_LOOP ,   ID_PLAY_ACTIVE_VIEWPORT }

Public Member Functions
	albaGUISettingsTimeBar (albaObserver *Listener, const albaString &label=_("Time Bar"))
	~albaGUISettingsTimeBar ()
void	OnEvent (albaEventBase *alba_event)
int	GetRealTimeMode ()
void	SetRealTimeMode (int realTime=0)
int	GetLoop ()
void	LoopAnimation (int loop=0)
void	AminateInSubrange (int animate_subrange=0)
int	GetAnimateSubrange ()
void	SetSubrange (double sub_range[2])
void	SetSubrange (double min, double max)
void	GetSubrange (double sub_range[2])
double *	GetSubrange ()
void	SetTimeMultiplier (double tmult=1.0)
double	GetTimeMultiplier ()
void	SetTimeScale (double tscale=1000.0)
double	GetTimeScale ()
void	PlayInActiveViewport (int active_viewport=0)
int	GetPlayingInActiveViewport ()
void	SetTimeBounds (double min, double max)
int	GetNumberOfFrames ()
void	SetNumberOfFrames (int frames)
void	SetTimeStep (double step)
Public Member Functions inherited from albaGUISettings
	albaGUISettings (albaObserver *Listener, const albaString &label=_("Settings"))
	~albaGUISettings ()
virtual void	OnEvent (albaEventBase *alba_event)
void	SetListener (albaObserver *Listener)
albaGUI *	GetGui ()
const char *	GetLabel ()
Public Member Functions inherited from albaObserver
	albaObserver ()
virtual	~albaObserver ()
virtual void	OnEvent (albaEventBase *e)=0

Protected Member Functions
void	CreateGui ()
void	InitializeSettings ()
void	EnableWidgets ()
void	Update ()
virtual void	CreateGui ()
virtual void	InitializeSettings ()

Protected Attributes
double	m_TimeMin
double	m_TimeMax
int	m_NumberOfFrames
double	m_TimeStep
int	m_RealTimeMode
int	m_Loop
int	m_PlayInActiveViewport
int	m_AnimateInSubrange
double	m_SubRange [2]
double	m_TimeSpeed
double	m_TimeScale
Protected Attributes inherited from albaGUISettings
albaGUI *	m_Gui
albaString	m_Label
wxConfig *	m_Config
albaObserver *	m_Listener

Detailed Description

class name: albaGUISettingsTimeBar Gui class for handling time bar properties inside application settings panel.

Definition at line 30 of file albaGUISettingsTimeBar.h.

Member Enumeration Documentation

STORAGE_SETTINGS_WIDGET_ID

enum albaGUISettingsTimeBar::STORAGE_SETTINGS_WIDGET_ID

Enumerator
ID_REAL_TIME
ID_TIME_SPEED
ID_TIME_SCALE
ID_TIME_STEP
ID_NUMBER_OF_FRAMES
ID_ANIMATE_IN_SUBRANGE
ID_SUBRANGE
ID_LOOP
ID_PLAY_ACTIVE_VIEWPORT

Definition at line 38 of file albaGUISettingsTimeBar.h.

Constructor & Destructor Documentation

albaGUISettingsTimeBar()

albaGUISettingsTimeBar::albaGUISettingsTimeBar	(	albaObserver *	Listener,
		const albaString &	label = _("Time Bar")
	)

constructor

~albaGUISettingsTimeBar()

albaGUISettingsTimeBar::~albaGUISettingsTimeBar

(

)

destructor

Member Function Documentation

OnEvent()

void albaGUISettingsTimeBar::OnEvent ( albaEventBase *  alba_event )

virtual

Answer to the messages coming from interface.

Reimplemented from albaGUISettings.

GetRealTimeMode()

int albaGUISettingsTimeBar::GetRealTimeMode ( )

inline

Return true if real time mode is active.

Definition at line 55 of file albaGUISettingsTimeBar.h.

References m_RealTimeMode.

SetRealTimeMode()

void albaGUISettingsTimeBar::SetRealTimeMode

(

int

realTime = 0

)

Set the play modality: real time or all frames.

GetLoop()

int albaGUISettingsTimeBar::GetLoop ( )

inline

Return true if loop animation is active.

Definition at line 61 of file albaGUISettingsTimeBar.h.

References m_Loop.

LoopAnimation()

void albaGUISettingsTimeBar::LoopAnimation

(

int

loop = 0

)

Turn On/Off the loop playback.

AminateInSubrange()

void albaGUISettingsTimeBar::AminateInSubrange

(

int

animate_subrange = 0

)

Turn On/Off the possibility to do the playback in a sub-range of the whole time range.

GetAnimateSubrange()

int albaGUISettingsTimeBar::GetAnimateSubrange ( )

inline

Return true if animation in subrange is active.

Definition at line 70 of file albaGUISettingsTimeBar.h.

References m_AnimateInSubrange.

SetSubrange() [1/2]

void albaGUISettingsTimeBar::SetSubrange

(

double

sub_range[2]

)

Set the subrange playback interval.

SetSubrange() [2/2]

void albaGUISettingsTimeBar::SetSubrange	(	double	min,
		double	max
	)

Set the subrange playback interval.

GetSubrange() [1/2]

void albaGUISettingsTimeBar::GetSubrange ( double  sub_range[2] )

inline

Return the playback subrange.

Definition at line 79 of file albaGUISettingsTimeBar.h.

References m_SubRange.

GetSubrange() [2/2]

double * albaGUISettingsTimeBar::GetSubrange ( )

inline

Return the playback subrange.

Definition at line 82 of file albaGUISettingsTimeBar.h.

References m_SubRange.

SetTimeMultiplier()

void albaGUISettingsTimeBar::SetTimeMultiplier

(

double

tmult = 1.0

)

Set the time multiplier to speed up or down the animation when the playback is not in real time.

GetTimeMultiplier()

double albaGUISettingsTimeBar::GetTimeMultiplier ( )

inline

Return the time multiplier.

Definition at line 89 of file albaGUISettingsTimeBar.h.

References m_TimeSpeed.

SetTimeScale()

void albaGUISettingsTimeBar::SetTimeScale

(

double

tscale = 1000.0

)

Set the time scale to transform milliseconds to the VME unit time.

Default value will transform milliseconds in seconds.

GetTimeScale()

double albaGUISettingsTimeBar::GetTimeScale ( )

inline

Return the time scale factor.

Definition at line 96 of file albaGUISettingsTimeBar.h.

References m_TimeScale.

PlayInActiveViewport()

void albaGUISettingsTimeBar::PlayInActiveViewport

(

int

active_viewport = 0

)

Enable/Disable the update of the animation only in the active viewport.

GetPlayingInActiveViewport()

int albaGUISettingsTimeBar::GetPlayingInActiveViewport ( )

inline

Return true if is active the flag for the update only into the active viewport.

Definition at line 102 of file albaGUISettingsTimeBar.h.

References m_PlayInActiveViewport.

SetTimeBounds()

void albaGUISettingsTimeBar::SetTimeBounds	(	double	min,
		double	max
	)

Called by the time bar to set the time-bounds of the loaded data tree.

GetNumberOfFrames()

int albaGUISettingsTimeBar::GetNumberOfFrames ( )

inline

Return the number of subdivision for the time bar.

Definition at line 108 of file albaGUISettingsTimeBar.h.

References m_NumberOfFrames.

SetNumberOfFrames()

void albaGUISettingsTimeBar::SetNumberOfFrames

(

int

frames

)

Set the number of frames.

SetTimeStep()

void albaGUISettingsTimeBar::SetTimeStep

(

double

step

)

Set the time step for the animation.

CreateGui()

void albaGUISettingsTimeBar::CreateGui ( )

protectedvirtual

Create the GUI for the setting panel.

Reimplemented from albaGUISettings.

InitializeSettings()

void albaGUISettingsTimeBar::InitializeSettings ( )

protectedvirtual

Initialize the application settings.

Reimplemented from albaGUISettings.

EnableWidgets()

void albaGUISettingsTimeBar::EnableWidgets ( )

protected

Enable/Disable widgets.

Update()

void albaGUISettingsTimeBar::Update ( )

protected

Update the GUI information according to the new values associated to the variables and flush these new values to the registry.

Member Data Documentation

m_TimeMin

double albaGUISettingsTimeBar::m_TimeMin

protected

Definition at line 130 of file albaGUISettingsTimeBar.h.

m_TimeMax

double albaGUISettingsTimeBar::m_TimeMax

protected

Definition at line 131 of file albaGUISettingsTimeBar.h.

m_NumberOfFrames

int albaGUISettingsTimeBar::m_NumberOfFrames

protected

Number of frames.

Definition at line 133 of file albaGUISettingsTimeBar.h.

Referenced by GetNumberOfFrames().

m_TimeStep

double albaGUISettingsTimeBar::m_TimeStep

protected

Time step linked to the number of frames and to the time range.

Definition at line 134 of file albaGUISettingsTimeBar.h.

m_RealTimeMode

int albaGUISettingsTimeBar::m_RealTimeMode

protected

Flag to play the animation in real time mode (checked) or to show all key-frames of the animation (unchecked)

Definition at line 135 of file albaGUISettingsTimeBar.h.

Referenced by GetRealTimeMode().

m_Loop

int albaGUISettingsTimeBar::m_Loop

protected

Definition at line 136 of file albaGUISettingsTimeBar.h.

Referenced by GetLoop().

m_PlayInActiveViewport

int albaGUISettingsTimeBar::m_PlayInActiveViewport

protected

Definition at line 137 of file albaGUISettingsTimeBar.h.

Referenced by GetPlayingInActiveViewport().

m_AnimateInSubrange

int albaGUISettingsTimeBar::m_AnimateInSubrange

protected

Definition at line 138 of file albaGUISettingsTimeBar.h.

Referenced by GetAnimateSubrange().

m_SubRange

double albaGUISettingsTimeBar::m_SubRange[2]

protected

Time subrange animation.

Definition at line 139 of file albaGUISettingsTimeBar.h.

Referenced by GetSubrange().

m_TimeSpeed

double albaGUISettingsTimeBar::m_TimeSpeed

protected

Multiplier to speed up the animation when is not in real time mode.

Definition at line 140 of file albaGUISettingsTimeBar.h.

Referenced by GetTimeMultiplier().

m_TimeScale

double albaGUISettingsTimeBar::m_TimeScale

protected

Time scale referring to the time base = seconds.

Definition at line 141 of file albaGUISettingsTimeBar.h.

Referenced by GetTimeScale().

---

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

• albaGUISettingsTimeBar.h