TuttleOFX  1
Defines
Interact Property Definitions
Ofx Properties
Collaboration diagram for Interact Property Definitions:

Defines

#define kOfxInteractPropSlaveToParam   "OfxInteractPropSlaveToParam"
 The set of parameters on which a value change will trigger a redraw for an interact.
#define kOfxInteractPropPixelScale   "OfxInteractPropPixelScale"
 The size of a real screen pixel under the interact's cannonical projection.
#define kOfxInteractPropViewportSize   "OfxInteractPropViewport"
 The size of an interact's openGL viewport.
#define kOfxInteractPropBackgroundColour   "OfxInteractPropBackgroundColour"
 The background colour of the application behind an interact instance.
#define kOfxInteractPropSuggestedColour   "OfxInteractPropSuggestedColour"
 The suggested colour to draw a widget in an interact, typically for overlays.
#define kOfxInteractPropPenPosition   "OfxInteractPropPenPosition"
 The position of the pen in an interact.
#define kOfxInteractPropPenViewportPosition   "OfxInteractPropPenViewportPosition"
 The position of the pen in an interact in viewport coordinates.
#define kOfxInteractPropPenPressure   "OfxInteractPropPenPressure"
 The pressure of the pen in an interact.
#define kOfxInteractPropBitDepth   "OfxInteractPropBitDepth"
 Indicates whether the dits per component in the interact's openGL frame buffer.
#define kOfxInteractPropHasAlpha   "OfxInteractPropHasAlpha"
 Indicates whether the interact's frame buffer has an alpha component or not.

Detailed Description

These are the list of properties used by the Interact API documented in CustomInteractionPage.

Define Documentation

#define kOfxInteractPropBackgroundColour   "OfxInteractPropBackgroundColour"

The background colour of the application behind an interact instance.

  • Type - double X 3
  • Property Set - read only on the interact instance and in argument to the kOfxInteractActionDraw action
  • Valid Values - from 0 to 1

The components are in the order red, green then blue.

Definition at line 101 of file ofxInteract.h.

Referenced by OFX::getBackgroundColour(), and tuttle::host::ofx::interact::OfxhInteract::initArgProp().

#define kOfxInteractPropBitDepth   "OfxInteractPropBitDepth"

Indicates whether the dits per component in the interact's openGL frame buffer.

  • Type - int X 1
  • Property Set - interact instance and descriptor (read only)

Definition at line 152 of file ofxInteract.h.

Referenced by tuttle::host::ofx::interact::OfxhInteractDescriptor::describe(), and OFX::Interact::getBitDepth().

#define kOfxInteractPropHasAlpha   "OfxInteractPropHasAlpha"

Indicates whether the interact's frame buffer has an alpha component or not.

  • Type - int X 1
  • Property Set - interact instance and descriptor (read only)
  • Valid Values - This must be one of
    • 0 indicates no alpha component
    • 1 indicates an alpha component

Definition at line 162 of file ofxInteract.h.

Referenced by tuttle::host::ofx::interact::OfxhInteractDescriptor::describe(), and OFX::Interact::hasAlpha().

#define kOfxInteractPropPenPosition   "OfxInteractPropPenPosition"

The position of the pen in an interact.

This value passes the postion of the pen into an interact. This is in the interact's canonical coordinates.

Definition at line 125 of file ofxInteract.h.

Referenced by OFX::PenArgs::PenArgs(), and tuttle::host::ofx::interact::OfxhInteract::setPenArgProps().

#define kOfxInteractPropPenPressure   "OfxInteractPropPenPressure"

The pressure of the pen in an interact.

This is used to indicate the status of the 'pen' in an interact. If a pen has only two states (eg: a mouse button), these should map to 0.0 and 1.0.

Definition at line 144 of file ofxInteract.h.

Referenced by OFX::PenArgs::PenArgs(), and tuttle::host::ofx::interact::OfxhInteract::setPenArgProps().

#define kOfxInteractPropPenViewportPosition   "OfxInteractPropPenViewportPosition"

The position of the pen in an interact in viewport coordinates.

This value passes the postion of the pen into an interact. This is in the interact's openGL viewport coordinates, with 0,0 being at the bottom left.

Definition at line 134 of file ofxInteract.h.

Referenced by tuttle::host::ofx::interact::OfxhInteract::setPenArgProps().

#define kOfxInteractPropPixelScale   "OfxInteractPropPixelScale"

The size of a real screen pixel under the interact's cannonical projection.

  • Type - double X 2
  • Property Set - interact instance and actions (read only)

Definition at line 81 of file ofxInteract.h.

Referenced by OFX::getPixelScale(), OFX::Interact::getPixelScale(), and tuttle::host::ofx::interact::OfxhInteract::initArgProp().

#define kOfxInteractPropSlaveToParam   "OfxInteractPropSlaveToParam"

The set of parameters on which a value change will trigger a redraw for an interact.

  • Type - string X N
  • Property Set - interact instance property (read/write)
  • Default - no values set
  • Valid Values - the name of any parameter associated with this interact.

If the interact is representing the state of some set of OFX parameters, then is will need to be redrawn if any of those parameters' values change. This multi-dimensional property links such parameters to the interact.

The interact can be slaved to multiple parameters (setting index 0, then index 1 etc...)

Definition at line 73 of file ofxInteract.h.

Referenced by OFX::Interact::addParamToSlaveTo(), tuttle::host::ofx::interact::OfxhInteract::getSlaveToParam(), and OFX::Interact::removeParamToSlaveTo().

#define kOfxInteractPropSuggestedColour   "OfxInteractPropSuggestedColour"

The suggested colour to draw a widget in an interact, typically for overlays.

  • Type - double X 3
  • Property Set - read only on the interact instance
  • Default - 1.0
  • Valid Values - greater than or equal to 0.0

Some applications allow the user to specify colours of any overlay via a colour picker, this property represents the value of that colour. Plugins are at liberty to use this or not when they draw an overlay.

If a host does not support such a colour, it should return kOfxStatReplyDefault

Definition at line 116 of file ofxInteract.h.

#define kOfxInteractPropViewportSize   "OfxInteractPropViewport"

The size of an interact's openGL viewport.

  • Type - int X 2
  • Property Set - read only property on the interact instance and in argument to all the interact actions.

This property is the redundant and its use will be deprecated in future releases.

Definition at line 90 of file ofxInteract.h.

Referenced by tuttle::host::ofx::interact::OfxhInteract::initArgProp().