Lumiera 0.pre.04~rc.1
»edit your freedom«
Loading...
Searching...
No Matches
Builder< TimeGrid > Struct Reference

#include "steam/asset/meta/time-grid.hpp"

Description

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

Public Attributes

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

Public Member Functions

 Builder (string const &nameID="")
 initialise to blank (zero).
 
lib::P< TimeGridcommit ()
 create a time grid based on settings within this builder
 

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 114 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::Configin 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 135 of file time-grid.cpp.

Referenced by TimeGridBasics_test::createGrid_fullProcedure().

+ Here is the caller graph for this function:

Member Data Documentation

◆ id

string id

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

◆ fps

FrameRate fps

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

Referenced by TimeGridBasics_test::createGrid_fullProcedure().

◆ origin

TimeVar origin

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

Referenced by TimeGridBasics_test::createGrid_fullProcedure().

◆ 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 107 of file time-grid.hpp.

Referenced by TimeGridBasics_test::createGrid_fullProcedure().

+ Collaboration diagram for Builder< TimeGrid >:

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