cgv::gui::trigger Class Reference

a trigger provides callbacks after a programmable time delay More...

#include <trigger.h>

Public Member Functions
	trigger ()
	default construction
bool	is_scheduled () const
	return whether a trigger is scheduled
bool	schedule_one_shot (double delay)
	schedule a trigger event in delay seconds, return whether this was successful
bool	schedule_recuring (double delay)
	start a recuring trigger with the given delay in seconds, return whether this was successful
double	get_delay () const
	return the delay used for scheduling the last time
bool	is_recuring () const
	return whether this is a recuring trigger
void	stop ()
	stop a recuring trigger

Static Public Member Functions
static double	get_current_time ()
	return the current time

Public Attributes
signal::signal< double, double >	shoot
	the shoot signal is called when the trigger is pulled and takes the current time and delay as argument

Protected Attributes
double	delay
bool	recur

Detailed Description

a trigger provides callbacks after a programmable time delay

Definition at line 13 of file trigger.h.

Constructor & Destructor Documentation

trigger()

cgv::gui::trigger::trigger

(

)

default construction

Definition at line 8 of file trigger.cxx.

Member Function Documentation

get_current_time()

double cgv::gui::trigger::get_current_time ( )

static

return the current time

Definition at line 70 of file trigger.cxx.

References cgv::gui::get_trigger_server().

Referenced by vr_view_interactor::draw_action_zone(), and cgv::gui::vr_server::grab_focus().

get_delay()

double cgv::gui::trigger::get_delay

(

)

const

return the delay used for scheduling the last time

Definition at line 48 of file trigger.cxx.

is_recuring()

bool cgv::gui::trigger::is_recuring

(

)

const

return whether this is a recuring trigger

Definition at line 54 of file trigger.cxx.

is_scheduled()

bool cgv::gui::trigger::is_scheduled

(

)

const

return whether a trigger is scheduled

Definition at line 14 of file trigger.cxx.

References cgv::gui::get_trigger_server().

schedule_one_shot()

bool cgv::gui::trigger::schedule_one_shot

(

double

delay

)

schedule a trigger event in delay seconds, return whether this was successful

schedule a trigger event in delay seconds

Definition at line 23 of file trigger.cxx.

References cgv::gui::get_trigger_server().

schedule_recuring()

bool cgv::gui::trigger::schedule_recuring

(

double

delay

)

start a recuring trigger with the given delay in seconds, return whether this was successful

start a recuring trigger with the given delay in seconds

Definition at line 36 of file trigger.cxx.

References cgv::gui::get_trigger_server().

Referenced by cgv::gui::get_animation_trigger().

stop()

void cgv::gui::trigger::stop

(

)

stop a recuring trigger

Definition at line 60 of file trigger.cxx.

References cgv::gui::get_trigger_server().

Member Data Documentation

delay

double cgv::gui::trigger::delay

protected

Definition at line 16 of file trigger.h.

recur

bool cgv::gui::trigger::recur

protected

Definition at line 17 of file trigger.h.

shoot

signal::signal<double,double> cgv::gui::trigger::shoot

the shoot signal is called when the trigger is pulled and takes the current time and delay as argument

Definition at line 36 of file trigger.h.

---

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

• cgv/gui/trigger.h
• cgv/gui/trigger.cxx