Main Page Namespace List Class Hierarchy Alphabetical List Compound List Namespace Members Compound Members Related Pages

# Composition Namespace Reference

The composition namespace. More...

## Compounds

- class Composition::ControllerC
- class Composition::EffectI
- class Composition::GizmoI
- class Composition::KeyC
- struct Composition::ParamIntC::LabelS
- class Composition::LayerC
- class Composition::ParamColorC
- class Composition::ParamFileC
- class Composition::ParamFloatC
- class Composition::ParamI
- class Composition::ParamIntC
- class Composition::ParamTextC
- class Composition::ParamVector2C
- class Composition::ParamVector3C
- class Composition::SceneC
- class Composition::TimeSegmentC

## Enumerations

- enum ControllerOrtE { CONT_ORT_NONE = 0, CONT_ORT_CONSTANT, CONT_ORT_REPEAT, CONT_ORT_LOOP }
- enum ControllerTypeE {
  CONT_TYPE_NONE = 0, CONT_TYPE_INT, CONT_TYPE_FLOAT, CONT_TYPE_VECTOR2,
  CONT_TYPE_VECTOR3, CONT_TYPE_COLOR
  }
- enum DefaultParamE { DEFAULT_PARAM_POSITION = 1, DEFAULT_PARAM_ROTATION = 2, DEFAULT_PARAM_SCALE = 3, DEFAULT_PARAM_PIVOT = 4 }
- enum KeyFlagsE {
  KEY_NOFLAGS = 0, KEY_SELECTED = 0x0001, KEY_LINEAR = 0x0002, KEY_SMOOTH = 0x0004,
  KEY_HOLD = 0x0008
  }
- enum ParameterTypesE {
  PARAM_TYPE_INT = 1, PARAM_TYPE_FLOAT, PARAM_TYPE_VECTOR2, PARAM_TYPE_VECTOR3,
  PARAM_TYPE_COLOR, PARAM_TYPE_TEXT, PARAM_TYPE_FILE
  }
- 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
  }

## Variables

- const PajaTypes::uint32 KEY_MAXCHANNELS = 4
- const bool PARAM_ANIMATABLE = true
- const bool PARAM_NOT_ANIMATABLE = false

## 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).

enum DefaultParamE

  | Predefined indices for get_gizmo(). This set of indices are used to get default parameters from effect. Enumeration values:
  DEFAULT_PARAM_POSITION | Position parameter.
  DEFAULT_PARAM_ROTATION | Rotation parameter.
  DEFAULT_PARAM_SCALE | Scale parameter.
  DEFAULT_PARAM_PIVOT | Pivot 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.

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).

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.

## 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.