Scene

Collaboration diagram for Scene:

Modules
	Fixture Preset

Data Structures
struct	DMX512_scene_s
	DMX512 scene structure object. More...

Macros
#define	DMX512_SCENE_DEFAULT   {0, 0, 0, 0, NULL, {}, DMX512_SCENE_IDLE, DMX512_SCENE_UNINITIALISED}
	scene instance default values More...

Enumerations
enum	DMX512_scene_status_e {   DMX512_SCENE_UNINITIALISED ,   DMX512_SCENE_INITIALISED }
	Status of a scene instance. More...
enum	DMX512_scene_state_e {   DMX512_SCENE_IDLE ,   DMX512_SCENE_FADEIN ,   DMX512_SCENE_FADEOUT }
	Current playing state of a scene. More...

Functions
DMX512_scene_s	DMX512_scene_new (uint16_t id, uint16_t fadein_time, uint16_t fadeout_time)
	Creates and initialises a new scene instance. More...
DMX512_engine_err_e	DMX512_scene_add_fixture_preset (DMX512_scene_s *scene, DMX512_fixture_preset_s fp)
	Adds a fixture preset instance into the scene. More...
DMX512_engine_err_e	DMX512_scene_del_fixture_preset (DMX512_scene_s *scene, uint16_t id)
	Deletes a fixture preset instance from the scene. More...
DMX512_fixture_preset_s *	DMX512_scene_get_fixture_preset (DMX512_scene_s *scene, uint16_t id)
	Gets a fixture instance from the pool. More...
void	DMX512_scene_start (DMX512_scene_s *scene)
	Starts a scene fade-in process. More...
void	DMX512_scene_stop (DMX512_scene_s *scene)
	Starts a scene fade-out process. More...
void	DMX512_scene_manage (DMX512_scene_s *scene)
	State machine to manage scene at a given state. More...
void	DMX512_scene_free (DMX512_scene_s *scene)
	Resets a scene to its uninitialised state. frees dynamically allocated scene Data. More...

Detailed Description

Scenes fundamentally define a set of fixtures pre-defined values to be transferred over to the DMX512 driver buffer at given any time. A scene's fixture preset values may be faded in and out over time.

Macro Definition Documentation

DMX512_SCENE_DEFAULT

#define DMX512_SCENE_DEFAULT   {0, 0, 0, 0, NULL, {}, DMX512_SCENE_IDLE, DMX512_SCENE_UNINITIALISED}

scene instance default values

Used during initialisation of a scene instance, it lowers the risk of conflicts by ensuring that every parameters which will be set are correctly initialised.

Definition at line 25 of file DMX512_scene.h.

Enumeration Type Documentation

DMX512_scene_state_e

enum DMX512_scene_state_e

Current playing state of a scene.

Used by the scene state machine to determine the current operation to be done on the scene based on its curent state value.

Enumerator
DMX512_SCENE_IDLE	The scene is currently not playing
DMX512_SCENE_FADEIN	Fading in fiture values
DMX512_SCENE_FADEOUT	Fading out fiture values

Definition at line 44 of file DMX512_scene.h.

DMX512_scene_status_e

enum DMX512_scene_status_e

Status of a scene instance.

Defines whether or not a scene instance has been correctly initialised.

Enumerator
DMX512_SCENE_UNINITIALISED	The scene instance is initialised
DMX512_SCENE_INITIALISED	The scene instance is uninitialised

Definition at line 33 of file DMX512_scene.h.

Function Documentation

DMX512_scene_add_fixture_preset()

DMX512_engine_err_e DMX512_scene_add_fixture_preset	(	DMX512_scene_s *	scene,
		DMX512_fixture_preset_s	fixture_preset
	)

Adds a fixture preset instance into the scene.

Parameters

*scene	pointer to the scene instance
fixture_preset	fixture_preset instance to be added to the scene

Returns

DMX512_engine_err_e error code following the function call

Definition at line 112 of file DMX512_scene.c.

DMX512_scene_del_fixture_preset()

DMX512_engine_err_e DMX512_scene_del_fixture_preset	(	DMX512_scene_s *	scene,
		uint16_t	id
	)

Deletes a fixture preset instance from the scene.

Parameters

*scene	pointer to the scene instance
id	the fixture preset's idendifier

Returns

DMX512_engine_err_e error code following the function call

Definition at line 137 of file DMX512_scene.c.

DMX512_scene_free()

void DMX512_scene_free

(

DMX512_scene_s *

scene

)

Resets a scene to its uninitialised state. frees dynamically allocated scene Data.

Parameters

*scene

pointer to the scene instance

Definition at line 212 of file DMX512_scene.c.

DMX512_scene_get_fixture_preset()

DMX512_fixture_preset_s * DMX512_scene_get_fixture_preset	(	DMX512_scene_s *	scene,
		uint16_t	id
	)

Gets a fixture instance from the pool.

Parameters

scene	pointer to the scene instance
id	the fixture preset identifier

Returns

*DMX512_fixture_preset_s pointer to the fixture preset instance

Definition at line 163 of file DMX512_scene.c.

DMX512_scene_manage()

void DMX512_scene_manage

(

DMX512_scene_s *

scene

)

State machine to manage scene at a given state.

Parameters

*scene

pointer to the scene instance to be managed

See also

DMX512_scene.h DMX512_scene_state_e state enumeration

Definition at line 198 of file DMX512_scene.c.

DMX512_scene_new()

DMX512_scene_s DMX512_scene_new	(	uint16_t	id,
		uint16_t	fadein_time,
		uint16_t	fadeout_time
	)

Creates and initialises a new scene instance.

Parameters

id	the scene identifier
fadein_time	the scene fade-in time in milliseconds
fadeout_time	the scene fade-out time in milliseconds

Returns

DMX512_scene_s the created scene

Definition at line 96 of file DMX512_scene.c.

DMX512_scene_start()

void DMX512_scene_start

(

DMX512_scene_s *

scene

)

Starts a scene fade-in process.

Parameters

*scene

pointer to the scene instance to be started

Definition at line 177 of file DMX512_scene.c.

DMX512_scene_stop()

void DMX512_scene_stop

(

DMX512_scene_s *

scene

)

Starts a scene fade-out process.

Parameters

*scene

pointer to the scene instance to be stopped

Definition at line 187 of file DMX512_scene.c.