Builder< TimeGrid > Struct Template Reference

Description

template<>
struct steam::asset::meta::Builder< TimeGrid >

Definition at line 97 of file time-grid.hpp.

Public Member Functions
	Builder (string const &nameID="")
	initialise to blank (zero). More...
lib::P< TimeGrid >	commit ()
	create a time grid based on settings within this builder More...

Public Attributes
FrameRate	fps
string	id
TimeVar	origin
lib::P< TimeGrid >	predecessor
	when building a compound or variable grid, the predecessor is the grid active before the origin of this (local) grid. More...

Constructor & Destructor Documentation

Builder()

Builder ( string const &  nameID = "" )

inline

initialise to blank (zero).

You need at least to set the framerate, in order to create a usable TimeGrid

Definition at line 116 of file time-grid.hpp.

Member Function Documentation

commit()

lib::P< TimeGrid > commit

(

)

create a time grid based on settings within this builder

Setup of a TimeGrid: validate the settings configured into this builder instance, then decide on the implementation strategy for the time grid.

Convert the given frames per second into an appropriate gridSpacing time and build a suitable name-ID to denote the TimeGrid-meta-Asset to be built.

Returns

shared_ptr holding onto the new asset::Meta, which has already been registered with the AssetManager.

Exceptions

error::Config

in case of invalid frames-per-second. The AssetManager might raise further exception when asset registration fails.

Note

the newly created grid is automatically published through the Advice System. This allows client code to pick up that grid definition just by using the Grid ID, without requiring an explicit link to the session or Asset subsystem.

Todo:

currently (12/2010) the AssetManager is unable to detect duplicate assets. Later on the intention is that in such cases, instead of creating a new grid we'll silently return the already registered existing and equivalent grid.

Definition at line 136 of file time-grid.cpp.

Referenced by TimeGrid::build().

Here is the caller graph for this function:

Member Data Documentation

predecessor

lib::P<TimeGrid> predecessor

when building a compound or variable grid, the predecessor is the grid active before the origin of this (local) grid.

Todo:

currently not supported (as of 12/2010)

Definition at line 109 of file time-grid.hpp.

Collaboration diagram for Builder< TimeGrid >:

---

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

• time-grid.hpp
• time-grid.cpp