Main Page | Modules | Class List | File List | Class Members | File Members

Interact Property Definitions
[Ofx Properties]

Detailed Description

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


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 kOfxInteractPropPenPosition   "OfxInteractPropPenPosition"
 The position of the pen in an interact.
#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.

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.

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

#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

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

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

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

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

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

Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:
  1. Redistributions of the document must retain the above copyright notice and this list of conditions.
  2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
Automatic documentation generated by DOxygen.