Public Member Functions | Public Attributes

PB2Value Struct Reference

This reference page is linked to from the following overview topics: Parameter Tags, Monitoring Parameter Changes.


Search for all occurrences

Detailed Description

See also:
Class IParamBlock2, Class PBAccessor, Class PBBitmap, Class ReferenceTarget, Class Control.
Remarks:
This structure holds the value in a ParamBlock2 or PBAccessor.

#include <iparamb2.h>

Inheritance diagram for PB2Value:
Inheritance graph
[legend]

List of all members.

Public Member Functions

PB2Export BOOL  is_constant ()
PB2Export void  Free (ParamType2 type)

Public Attributes

union {
   int   i
  This is used by: TYPE_INT, TYPE_BOOL, TYPE_TIMEVALUE, TYPE_RADIOBTN_INDEX, TYPE_INDEX.
   float   f
  This is used by: TYPE_FLOAT, TYPE_ANGLE, TYPE_PCNT_FRAC, TYPE_WORLD, TYPE_COLOR_CHANNEL.
   Point3 *   p
  This is used by: TYPE_POINT3, TYPE_RGBA, TYPE_HSV.
   Point4 *   p4
  This is used by: TYPE_POINT4, TYPE_FRGBA.
   TimeValue   t
  This is used by TYPE_TIMEVALUE.
   MCHAR *   s
  This is used by TYPE_FILENAME or TYPE_STRING.
   PBBitmap *   bm
  This is used by TYPE_BITMAP.
   ReferenceTarget *   r
  A generic reference target pointer (Mtl*, Texmap*, INode*).
   Matrix3 *   m
  This is used by TYPE_MATRIX3.
   Control *   control
  This value replaces the i, f, p, p4, or t values if they are actually animated (and thus have a controller assigned).
   Point2 *   p2
  This is used by: TYPE_POINT2.
}; 
BYTE  flags
  These flags are for internal use only, do not alter them.

Member Function Documentation

PB2Export BOOL is_constant ( )
PB2Export void Free ( ParamType2  type )

Member Data Documentation

int i

This is used by: TYPE_INT, TYPE_BOOL, TYPE_TIMEVALUE, TYPE_RADIOBTN_INDEX, TYPE_INDEX.

float f

This is used by: TYPE_FLOAT, TYPE_ANGLE, TYPE_PCNT_FRAC, TYPE_WORLD, TYPE_COLOR_CHANNEL.

This is used by: TYPE_POINT3, TYPE_RGBA, TYPE_HSV.

This is used by: TYPE_POINT4, TYPE_FRGBA.

TimeValue t

This is used by TYPE_TIMEVALUE.

MCHAR* s

This is used by TYPE_FILENAME or TYPE_STRING.

This is used by TYPE_BITMAP.

A generic reference target pointer (Mtl*, Texmap*, INode*).

This is used by TYPE_MATRIX3.

Note that TYPE_MATRIX3 items cannot be animated.

This value replaces the i, f, p, p4, or t values if they are actually animated (and thus have a controller assigned).

This is used by: TYPE_POINT2.

union { ... }
BYTE flags

These flags are for internal use only, do not alter them.