---

Composition Namespace Reference

The composition namespace. More...

Compounds
class	AutoGizmoC
	Auto gizmo class. More...
class	ControllerC
	Value controller class. More...
class	EffectI
	The effect interface. More...
class	FileKeyC
	File Keyframe class for controller. More...
class	FloatKeyC
	Float Keyframe class for controller. More...
class	GizmoI
	Gizmo interface. More...
class	KeyC
	Keyframe class for controller. More...
struct	MarkerS
class	ParamColorC
	Color parameter class. More...
class	ParamFileC
	File parameter class. More...
class	ParamFloatC
	Float parameter class. More...
struct	LabelS
class	LayerC
	Composition Layer class. More...
class	ParamI
	Parameter class. More...
class	ParamIntC
	Integer parameter class. More...
class	ParamTextC
	Text parameter class. More...
class	ParamVector2C
	2D vector parameter class. More...
class	ParamVector3C
	3D vector parameter class. More...
class	SceneC
	Composition scene class. More...
class	TimeSegmentC
	Time segment class. More...
Enumerations
enum	ItemFlagsE {   ITEM_EXPANDED = 0x0001, ITEM_SELECTED = 0x0002, ITEM_VISIBLE = 0x0004, ITEM_LOCKED = 0x0008,   ITEM_LAYER = 0x0010, ITEM_EFFECT = 0x0020, ITEM_GIZMO = 0x0040, ITEM_PARAMETER = 0x0080,   ITEM_ANIMATED = 0x0100, ITEM_ANIMATABLE = 0x0200, ITEM_CLAMPVALUES = 0x0400, ITEM_EXPANDABLE = 0x0800,   ITEM_GUIHIDDEN = 0x1000 }
	Common flags Effect, Gizmo, and Parameter. More...
enum	ControllerOrtE { CONT_ORT_NONE = 0, CONT_ORT_CONSTANT, CONT_ORT_REPEAT, CONT_ORT_LOOP }
	Controller out of range types. More...
enum	ControllerTypeE {   CONT_TYPE_NONE = 0, CONT_TYPE_INT, CONT_TYPE_FLOAT, CONT_TYPE_VECTOR2,   CONT_TYPE_VECTOR3, CONT_TYPE_COLOR, CONT_TYPE_FILE }
	Controller type. More...
enum	DefaultParamE { DEFAULT_PARAM_POSITION = 1, DEFAULT_PARAM_ROTATION = 2, DEFAULT_PARAM_SCALE = 3, DEFAULT_PARAM_PIVOT = 4 }
	Predefined indices for get_gizmo(). More...
enum	KeyFlagsE {   KEY_NOFLAGS = 0, KEY_SELECTED = 0x0001, KEY_LINEAR = 0x0002, KEY_SMOOTH = 0x0004,   KEY_HOLD = 0x0008, KEY_FILE = 0x0010 }
	Key flags. More...
enum	ParameterTypesE {   PARAM_TYPE_INT = 1, PARAM_TYPE_FLOAT, PARAM_TYPE_VECTOR2, PARAM_TYPE_VECTOR3,   PARAM_TYPE_COLOR, PARAM_TYPE_TEXT, PARAM_TYPE_FILE }
	Parameter types. More...
enum	ParamStyleE {   PARAM_STYLE_EDITBOX = 0x0001, PARAM_STYLE_COMBOBOX = 0x0002, PARAM_STYLE_TEXTPARAGRAPH = 0x0004, PARAM_STYLE_FILE = 0x0008,   PARAM_STYLE_COLORPICKER = 0x0010, PARAM_STYLE_PERCENT = 0x0020, PARAM_STYLE_ANGLE = 0x0040, PARAM_STYLE_ABS_POSITION = 0x0080,   PARAM_STYLE_REL_POSITION = 0x0100, PARAM_STYLE_WORLD_SPACE = 0x0200, PARAM_STYLE_OBJECT_SPACE = 0x0400 }
	Parameter styles. More...
enum	ParamSetValNotifyE { PARAM_NOTIFY_NONE = 0, PARAM_NOTIFY_UI_CHANGE }
	Parameter value change notifications. More...
Variables
const PajaTypes::uint32	KEY_MAXCHANNELS = 4
	Maximum number of channels in a key.
const bool	PARAM_ANIMATABLE = true
	Constant for parameter creation.
const bool	PARAM_NOT_ANIMATABLE = false
	Constant for parameter creation.

---

Detailed Description

The composition namespace.

The classes collected into the Composition namespace are used as parts of demo composition. The classes range from a controller and parameter to a layer or complete scene.

---

Enumeration Type Documentation

enum ControllerOrtE

Controller out of range types. Enumeration values: CONT_ORT_CONSTANT  The out of range curve. CONT_ORT_REPEAT  The curve is repeated. CONT_ORT_LOOP  The curve is looped.

enum ControllerTypeE

Controller type. Enumeration values: CONT_TYPE_INT  Controller is used to interpolate integer values (1 channel). CONT_TYPE_FLOAT  Controller is used to interpolate floating point values (1 channel). CONT_TYPE_VECTOR2  Controller is used to interpolate 2D vector values (2 channel). CONT_TYPE_VECTOR3  Controller is used to interpolate 3D vector values (3 channel). CONT_TYPE_COLOR  Controller is used to interpolate color values (4 channel). CONT_TYPE_FILE  Controller is used to arrange files.

enum DefaultParamE

Predefined indices for get_gizmo(). This set of indices are used to get default parameters from effect. See also: EffectI::get_default_param(). Enumeration values: DEFAULT_PARAM_POSITION  Position parameter. DEFAULT_PARAM_ROTATION  Rotation parameter. DEFAULT_PARAM_SCALE  Scale parameter. DEFAULT_PARAM_PIVOT  Pivot parameter.

enum ItemFlagsE

Common flags Effect, Gizmo, and Parameter.

enum KeyFlagsE

Key flags. Enumeration values: KEY_SELECTED  Key is selected (used only in editor). KEY_LINEAR  Key uses linear interpolation. KEY_SMOOTH  Key uses smooth (TCB spline) interpolation. KEY_HOLD  Key uses hold interpolation. KEY_FILE  Key is file key.

enum ParameterTypesE

Parameter types. Enumeration values: PARAM_TYPE_INT  Integer parameter. PARAM_TYPE_FLOAT  Floating-point value parameter. PARAM_TYPE_VECTOR2  2D vector parameter. PARAM_TYPE_VECTOR3  3D vector parameter. PARAM_TYPE_COLOR  Color parameter. PARAM_TYPE_TEXT  Text parameter. PARAM_TYPE_FILE  File parameter.

enum ParamSetValNotifyE

Parameter value change notifications. Enumeration values: PARAM_NOTIFY_NONE  No notify. PARAM_NOTIFY_UI_CHANGE  The gizmo/parameter layout has change and UI needs to be refreshed.

enum ParamStyleE

Parameter styles. Enumeration values: PARAM_STYLE_EDITBOX  Parameter has editbox type-in. PARAM_STYLE_COMBOBOX  Parameter has combobox (drop down selection box) type-in. PARAM_STYLE_TEXTPARAGRAPH  Parameter has text paragraph type-in (not implemented). PARAM_STYLE_FILE  Parameter has file type-in. PARAM_STYLE_COLORPICKER  Parameter has color picked type-in. PARAM_STYLE_PERCENT  Parameter is percentage. PARAM_STYLE_ANGLE  Parameter is angle. PARAM_STYLE_ABS_POSITION  Positional parameter is absolute position (in screen space). PARAM_STYLE_REL_POSITION  Positional parameter is relative position to the effect center. PARAM_STYLE_WORLD_SPACE  Positional parameter is in world space (screen space). PARAM_STYLE_OBJECT_SPACE  Positional parameter is object space (effect space).

---

Variable Documentation

const PajaTypes::uint32 KEY_MAXCHANNELS = 4

Maximum number of channels in a key. This cosntant represent the maximum number of channels (values) the get_value() method may return.

const bool PARAM_ANIMATABLE = true

Constant for parameter creation.

const bool PARAM_NOT_ANIMATABLE = false

Constant for parameter creation.

---