Inheritance diagram for ginga::Object:

[legend]

Collaboration diagram for ginga::Object:

[legend]

Public Member Functions
	Object (const string &)

string	getId ()

Document *	getDocument ()

void	initDocument (Document *)

Composition *	getParent ()

void	initParent (Composition *)

virtual string	getObjectTypeAsString ()=0

virtual string	toString ()

const list< pair< string, Composition * > > *	getAliases ()

bool	hasAlias (const string &)

void	addAlias (const string &, Composition *=nullptr)

const set< Event * > *	getEvents ()

Event *	getEvent (Event::Type, const string &)

Event *	getAttributionEvent (const string &)

void	addAttributionEvent (const string &)

Event *	getPresentationEvent (const string &)

Event *	getPresentationEventByLabel (const string &)

void	addPresentationEvent (const string &, Time, Time)

void	addPresentationEvent (const string &, const string &)

Event *	getSelectionEvent (const string &)

void	addSelectionEvent (const string &)

Event *	getLookAtEvent (const string &)

void	addLookAtEvent (const string &)

Event *	getLambda ()

bool	isOccurring ()

bool	isPaused ()

bool	isSleeping ()

virtual string	getProperty (const string &)

virtual void	setProperty (const string &, const string &, Time dur=0)

const list< pair< Action, Time > > *	getDelayedActions ()

void	addDelayedAction (Event *, Event::Transition, const string &value="", Time delay=0)

virtual void	sendKey (const string &, bool)

virtual void	sendTick (Time, Time, Time)

Time	getTime ()

virtual bool	beforeTransition (Event *, Event::Transition)=0
	Initiates event transition.

virtual bool	afterTransition (Event *, Event::Transition)=0
	Finishes event transition.

Protected Member Functions
virtual void	doStart ()

virtual void	doStop ()

Protected Attributes
string	_id

Document *	_doc

Composition *	_parent

list< pair< string, Composition * > >	_aliases

Time	_time

map< string, string >	_properties

Event *	_lambda

set< Event * >	_events

list< pair< Action, Time > >	_delayed

Member Function Documentation

◆ afterTransition()

virtual bool ginga::Object::afterTransition	(	Event *	,
		Event::Transition	)

pure virtual

Finishes event transition.

This function is called by Event::transition() immediately after transitioning evt. If the transition can finish successfully, the function returns true. Otherwise, if the transition must be reverted, e.g., due to some error, the function returns false.

Parameters

evt	Event that was transitioned.
transition	The transition.

Returns: true if successful, or false otherwise (cancel transition).

Implemented in ginga::Context, ginga::Media, and ginga::Switch.

◆ beforeTransition()

virtual bool ginga::Object::beforeTransition	(	Event *	,
		Event::Transition	)

pure virtual

Initiates event transition.

This function is called by Event::transition() immediately before transitioning evt. If the transition can go on, the function returns true. Otherwise, if the transition must be cancelled, e.g., due to some error, the function returns false.

Parameters

evt	Event to be transitioned.
transition	The desired transition.

Returns: true if successful, or false otherwise (cancel transition).

Implemented in ginga::Context, ginga::Media, and ginga::Switch.

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

/__w/ginga/ginga/lib/Object.h
/__w/ginga/ginga/lib/Object.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ afterTransition()

◆ beforeTransition()