HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PRM_Type Class Reference

#include <PRM_Type.h>

Public Types

enum  PRM_BasicType {
  PRM_BASIC_NONE = 0x00000000, PRM_BASIC_ORDINAL = 0x00000001, PRM_BASIC_FLOAT = 0x00000002, PRM_BASIC_STRING = 0x00000004,
  PRM_BASIC_DATA = 0x00000008, PRM_BASIC_MASK = 0x0000000F
}
 
enum  PRM_FloatType {
  PRM_FLOAT_NONE = 0x00000000, PRM_FLOAT_INTEGER = 0x00000001, PRM_FLOAT_POLAR = 0x00000004, PRM_FLOAT_POLARJACK = 0x00000008,
  PRM_FLOAT_ANGLEJACK = 0x00000010, PRM_FLOAT_SPINNER = 0x00000020, PRM_FLOAT_RANGE = 0x00000080, PRM_FLOAT_HUECIRCLE = 0x00000100,
  PRM_FLOAT_GREYRANGE = 0x00000200, PRM_FLOAT_SLIDERFRAC = 0x00000800, PRM_FLOAT_MINMAX_R = 0x00002000, PRM_FLOAT_MINMAX_G = 0x00004000,
  PRM_FLOAT_MINMAX_B = 0x00008000, PRM_FLOAT_MINMAX_A = 0x00010000, PRM_FLOAT_MINMAX_RGBA = 0x00020000, PRM_FLOAT_MINMAX_MASK = 0x0003E000,
  PRM_FLOAT_PALETTE = 0x00040000, PRM_FLOAT_RAMPEDIT = 0x00080000, PRM_FLOAT_RGBA = 0x00100000, PRM_FLOAT_LOGARITHMIC = 0x00200000
}
 
enum  PRM_OrdinalType {
  PRM_ORD_NONE = 0x00000000, PRM_ORD_TOGGLE = 0x00000001, PRM_ORD_CALLBACK = 0x00000002, PRM_ORD_SWITCHERLIST = 0x00000004,
  PRM_ORD_RGBAMASK = 0x00000008, PRM_ORD_BUTTONSTRIP = 0x00000010, PRM_ORD_ICONSTRIP = 0x00000020
}
 
enum  PRM_StringType {
  PRM_STR_NONE = 0x00000000, PRM_STR_CMD = 0x00000001, PRM_STR_PATH = 0x00000002, PRM_STR_ALPHA = 0x00000004,
  PRM_STR_OP_REF_LIST = 0x00000008, PRM_STR_OP_REF_NAME = 0x00000010, PRM_STR_OP_REF_DATA = 0x00000020, PRM_STR_OP_REF_PARM = 0x00000040,
  PRM_STR_OP_REF_CHILD = 0x00000080, PRM_STR_OP_REF_MASK = 0x000000F8, PRM_STR_UNQUOTED = 0x00000100, PRM_STR_LABEL = 0x00000200,
  PRM_STR_SEPARATOR = 0x00000400
}
 
enum  PRM_DataType { PRM_DATA_NONE = 0x00000000, PRM_DATA_GEOMETRY = 0x00000001, PRM_DATA_KEY_VALUE_DICT = 0x00000002, PRM_DATA_GEODELTA = 0x00000004 }
 
enum  PRM_PathType {
  PRM_PATH_NONE = 0x00000000, PRM_PATH_PIC = 0x00000001, PRM_PATH_GEO = 0x00000002, PRM_PATH_RAMP = 0x00000004,
  PRM_PATH_CAPT = 0x00000008, PRM_PATH_CLIP = 0x00000010, PRM_PATH_PAINT = 0x00000040, PRM_PATH_LUT = 0x00000080,
  PRM_PATH_CMDF = 0x00000100, PRM_PATH_MIDI = 0x00000200, PRM_PATH_TXT = 0x00000400, PRM_PATH_I3D = 0x00000800,
  PRM_PATH_CHAN = 0x00001000, PRM_PATH_SIM = 0x00002000, PRM_PATH_SIMDATA = 0x00004000, PRM_PATH_ICON = 0X00008000,
  PRM_PATH_DIRECTORY = 0X00010000, PRM_PATH_MASK = 0x0001FFFF
}
 
enum  PRM_ChannelType {
  PRM_CHAN_NONE = 0x00000000, PRM_CHAN_NAMEXYZW = 0x00000001, PRM_CHAN_NAMEUVW = 0x00000002, PRM_CHAN_NAMERGB = 0x00000004,
  PRM_CHAN_NAMEBEGINEND = 0x00000008, PRM_CHAN_NAMEMAXMIN = 0x00000010, PRM_CHAN_NAMEMINMAX = 0x00000020, PRM_CHAN_NAMESTARTEND = 0x00000040,
  PRM_CHAN_NAMEXYWH = 0x00000080, PRM_CHAN_MASK = 0x000000FF
}
 
enum  PRM_InterfaceType {
  PRM_INTERFACE_NONE = 0x00000000, PRM_INTERFACE_INVISIBLE = 0x00000001, PRM_INTERFACE_EXCLUSIVE = 0x00000002, PRM_INTERFACE_JOIN_NEXT = 0x00000004,
  PRM_INTERFACE_LABEL_NONE = 0x00000008, PRM_INTERFACE_PLAIN = 0x00000010, PRM_INTERFACE_CHANNEL = 0x00000020, PRM_INTERFACE_JOIN_EXT = 0x00000040
}
 
enum  PRM_BehaviorType {
  PRM_BEHAVIOR_NONE = 0x00000000, PRM_BEHAVIOR_NOREFRESH = 0x00000001, PRM_BEHAVIOR_NORESIM = 0x00000002, PRM_BEHAVIOR_NOCOOK = 0x00000004,
  PRM_BEHAVIOR_BASEPARM = 0x00000008
}
 

Public Member Functions

 PRM_Type ()
 
 PRM_Type (const PRM_Type &t)
 
 PRM_Type (const PRM_BasicType &bt)
 
 PRM_Type (const PRM_FloatType &at)
 
 PRM_Type (const PRM_OrdinalType &ot)
 
 PRM_Type (const PRM_StringType &st)
 
 PRM_Type (const PRM_DataType &st)
 
 PRM_Type (const PRM_PathType &pt)
 
 PRM_Type (const PRM_ChannelType &ct)
 
 PRM_Type (const PRM_InterfaceType &it)
 
 PRM_Type (const PRM_BehaviorType &vt)
 
 PRM_Type (const PRM_BasicType &bt, const PRM_FloatType &at, const PRM_OrdinalType &ot, const PRM_StringType &st, const PRM_DataType &dt, const PRM_PathType &pt, const PRM_ChannelType &ct, const PRM_InterfaceType &it, const PRM_BehaviorType &vt)
 
 ~PRM_Type ()
 
void init ()
 
void saveBinary (std::ostream &os) const
 
void saveASCII (std::ostream &os) const
 
bool loadBinary (UT_IStream &is)
 
void invert ()
 
void stripUiType ()
 
const PRM_Typeoperator= (const PRM_Type &t)
 
bool operator== (const PRM_Type &t) const
 
bool operator!= (const PRM_Type &t) const
 
void operator|= (const PRM_Type &t)
 
void operator&= (const PRM_Type &t)
 
 operator bool () const
 
bool isBasicType (const PRM_BasicType &t) const
 
bool isChannelType (const PRM_ChannelType &t) const
 
bool hasFloatType (const PRM_FloatType &mask) const
 
bool hasOrdinalType (const PRM_OrdinalType &mask) const
 
bool hasStringType (const PRM_StringType &mask) const
 
bool hasDataType (const PRM_DataType &mask) const
 
bool hasPathType (const PRM_PathType &mask) const
 
bool hasInterfaceType (const PRM_InterfaceType &mask) const
 
bool hasBehaviorType (const PRM_BehaviorType &mask) const
 
bool isOrdinalType () const
 
bool isFloatType () const
 
bool isStringType () const
 
bool isDataType () const
 
bool isVisible () const
 
bool isAnimatible () const
 
bool isSwitcher () const
 
bool isCookable () const
 
const PRM_BasicTypegetBasicType () const
 
const PRM_FloatTypegetFloatType () const
 
const PRM_OrdinalTypegetOrdinalType () const
 
const PRM_StringTypegetStringType () const
 
const PRM_DataTypegetDataType () const
 
const PRM_PathTypegetPathType () const
 
const PRM_ChannelTypegetChannelType () const
 
const PRM_InterfaceTypegetInterfaceType () const
 
const PRM_BehaviorTypegetBehaviorType () const
 

Friends

const PRM_Type operator| (const PRM_Type &t1, const PRM_Type &t2)
 
const PRM_Type operator& (const PRM_Type &t1, const PRM_Type &t2)
 
const PRM_Type operator~ (const PRM_Type &t1)
 
const PRM_Type PRM_STRIP_UI_TYPE (const PRM_Type &t1)
 

Detailed Description

Examples:
OBJ/OBJ_WorldAlign.C, and SOP/SOP_BrushHairLen.C.

Definition at line 25 of file PRM_Type.h.

Member Enumeration Documentation

Enumerator
PRM_BASIC_NONE 
PRM_BASIC_ORDINAL 
PRM_BASIC_FLOAT 
PRM_BASIC_STRING 
PRM_BASIC_DATA 
PRM_BASIC_MASK 

Definition at line 30 of file PRM_Type.h.

Enumerator
PRM_BEHAVIOR_NONE 
PRM_BEHAVIOR_NOREFRESH 
PRM_BEHAVIOR_NORESIM 
PRM_BEHAVIOR_NOCOOK 
PRM_BEHAVIOR_BASEPARM 

Definition at line 188 of file PRM_Type.h.

Enumerator
PRM_CHAN_NONE 
PRM_CHAN_NAMEXYZW 
PRM_CHAN_NAMEUVW 
PRM_CHAN_NAMERGB 
PRM_CHAN_NAMEBEGINEND 
PRM_CHAN_NAMEMAXMIN 
PRM_CHAN_NAMEMINMAX 
PRM_CHAN_NAMESTARTEND 
PRM_CHAN_NAMEXYWH 
PRM_CHAN_MASK 

Definition at line 152 of file PRM_Type.h.

Enumerator
PRM_DATA_NONE 
PRM_DATA_GEOMETRY 
PRM_DATA_KEY_VALUE_DICT 
PRM_DATA_GEODELTA 

Definition at line 112 of file PRM_Type.h.

Enumerator
PRM_FLOAT_NONE 
PRM_FLOAT_INTEGER 
PRM_FLOAT_POLAR 
PRM_FLOAT_POLARJACK 
PRM_FLOAT_ANGLEJACK 
PRM_FLOAT_SPINNER 
PRM_FLOAT_RANGE 
PRM_FLOAT_HUECIRCLE 
PRM_FLOAT_GREYRANGE 
PRM_FLOAT_SLIDERFRAC 
PRM_FLOAT_MINMAX_R 
PRM_FLOAT_MINMAX_G 
PRM_FLOAT_MINMAX_B 
PRM_FLOAT_MINMAX_A 
PRM_FLOAT_MINMAX_RGBA 
PRM_FLOAT_MINMAX_MASK 
PRM_FLOAT_PALETTE 
PRM_FLOAT_RAMPEDIT 
PRM_FLOAT_RGBA 
PRM_FLOAT_LOGARITHMIC 

Definition at line 40 of file PRM_Type.h.

Enumerator
PRM_INTERFACE_NONE 
PRM_INTERFACE_INVISIBLE 
PRM_INTERFACE_EXCLUSIVE 
PRM_INTERFACE_JOIN_NEXT 
PRM_INTERFACE_LABEL_NONE 
PRM_INTERFACE_PLAIN 
PRM_INTERFACE_CHANNEL 
PRM_INTERFACE_JOIN_EXT 

Definition at line 166 of file PRM_Type.h.

Enumerator
PRM_ORD_NONE 
PRM_ORD_TOGGLE 
PRM_ORD_CALLBACK 
PRM_ORD_SWITCHERLIST 
PRM_ORD_RGBAMASK 
PRM_ORD_BUTTONSTRIP 
PRM_ORD_ICONSTRIP 

Definition at line 77 of file PRM_Type.h.

Enumerator
PRM_PATH_NONE 
PRM_PATH_PIC 
PRM_PATH_GEO 
PRM_PATH_RAMP 
PRM_PATH_CAPT 
PRM_PATH_CLIP 
PRM_PATH_PAINT 
PRM_PATH_LUT 
PRM_PATH_CMDF 
PRM_PATH_MIDI 
PRM_PATH_TXT 
PRM_PATH_I3D 
PRM_PATH_CHAN 
PRM_PATH_SIM 
PRM_PATH_SIMDATA 
PRM_PATH_ICON 
PRM_PATH_DIRECTORY 
PRM_PATH_MASK 

Definition at line 123 of file PRM_Type.h.

Enumerator
PRM_STR_NONE 
PRM_STR_CMD 
PRM_STR_PATH 
PRM_STR_ALPHA 
PRM_STR_OP_REF_LIST 
PRM_STR_OP_REF_NAME 
PRM_STR_OP_REF_DATA 
PRM_STR_OP_REF_PARM 
PRM_STR_OP_REF_CHILD 
PRM_STR_OP_REF_MASK 
PRM_STR_UNQUOTED 
PRM_STR_LABEL 
PRM_STR_SEPARATOR 

Definition at line 88 of file PRM_Type.h.

Constructor & Destructor Documentation

PRM_Type::PRM_Type ( )
inline

Definition at line 879 of file PRM_Type.h.

PRM_Type::PRM_Type ( const PRM_Type t)
inline

Definition at line 885 of file PRM_Type.h.

PRM_Type::PRM_Type ( const PRM_BasicType bt)
inline

Definition at line 891 of file PRM_Type.h.

PRM_Type::PRM_Type ( const PRM_FloatType at)
inline

Definition at line 898 of file PRM_Type.h.

PRM_Type::PRM_Type ( const PRM_OrdinalType ot)
inline

Definition at line 905 of file PRM_Type.h.

PRM_Type::PRM_Type ( const PRM_StringType st)
inline

Definition at line 912 of file PRM_Type.h.

PRM_Type::PRM_Type ( const PRM_DataType st)
inline

Definition at line 919 of file PRM_Type.h.

PRM_Type::PRM_Type ( const PRM_PathType pt)
inline

Definition at line 926 of file PRM_Type.h.

PRM_Type::PRM_Type ( const PRM_ChannelType ct)
inline

Definition at line 933 of file PRM_Type.h.

PRM_Type::PRM_Type ( const PRM_InterfaceType it)
inline

Definition at line 940 of file PRM_Type.h.

PRM_Type::PRM_Type ( const PRM_BehaviorType vt)
inline

Definition at line 947 of file PRM_Type.h.

PRM_Type::PRM_Type ( const PRM_BasicType bt,
const PRM_FloatType at,
const PRM_OrdinalType ot,
const PRM_StringType st,
const PRM_DataType dt,
const PRM_PathType pt,
const PRM_ChannelType ct,
const PRM_InterfaceType it,
const PRM_BehaviorType vt 
)
inline

Definition at line 954 of file PRM_Type.h.

PRM_Type::~PRM_Type ( )
inline

Definition at line 234 of file PRM_Type.h.

Member Function Documentation

const PRM_Type::PRM_BasicType & PRM_Type::getBasicType ( ) const
inline

Definition at line 1129 of file PRM_Type.h.

const PRM_Type::PRM_BehaviorType & PRM_Type::getBehaviorType ( ) const
inline

Definition at line 1177 of file PRM_Type.h.

const PRM_Type::PRM_ChannelType & PRM_Type::getChannelType ( ) const
inline

Definition at line 1165 of file PRM_Type.h.

const PRM_Type::PRM_DataType & PRM_Type::getDataType ( ) const
inline

Definition at line 1153 of file PRM_Type.h.

const PRM_Type::PRM_FloatType & PRM_Type::getFloatType ( ) const
inline

Definition at line 1135 of file PRM_Type.h.

const PRM_Type::PRM_InterfaceType & PRM_Type::getInterfaceType ( ) const
inline

Definition at line 1171 of file PRM_Type.h.

const PRM_Type::PRM_OrdinalType & PRM_Type::getOrdinalType ( ) const
inline

Definition at line 1141 of file PRM_Type.h.

const PRM_Type::PRM_PathType & PRM_Type::getPathType ( ) const
inline

Definition at line 1159 of file PRM_Type.h.

const PRM_Type::PRM_StringType & PRM_Type::getStringType ( ) const
inline

Definition at line 1147 of file PRM_Type.h.

bool PRM_Type::hasBehaviorType ( const PRM_BehaviorType mask) const
inline

Definition at line 1123 of file PRM_Type.h.

bool PRM_Type::hasDataType ( const PRM_DataType mask) const
inline

Definition at line 1105 of file PRM_Type.h.

bool PRM_Type::hasFloatType ( const PRM_FloatType mask) const
inline

Definition at line 1087 of file PRM_Type.h.

bool PRM_Type::hasInterfaceType ( const PRM_InterfaceType mask) const
inline

Definition at line 1117 of file PRM_Type.h.

bool PRM_Type::hasOrdinalType ( const PRM_OrdinalType mask) const
inline

Definition at line 1093 of file PRM_Type.h.

bool PRM_Type::hasPathType ( const PRM_PathType mask) const
inline

Definition at line 1111 of file PRM_Type.h.

bool PRM_Type::hasStringType ( const PRM_StringType mask) const
inline

Definition at line 1099 of file PRM_Type.h.

void PRM_Type::init ( void  )
inline

Definition at line 866 of file PRM_Type.h.

void PRM_Type::invert ( )
inline

Definition at line 1054 of file PRM_Type.h.

bool PRM_Type::isAnimatible ( ) const
inline

Definition at line 278 of file PRM_Type.h.

bool PRM_Type::isBasicType ( const PRM_BasicType t) const
inline

Definition at line 1075 of file PRM_Type.h.

bool PRM_Type::isChannelType ( const PRM_ChannelType t) const
inline

Definition at line 1081 of file PRM_Type.h.

bool PRM_Type::isCookable ( ) const
inline

Definition at line 286 of file PRM_Type.h.

bool PRM_Type::isDataType ( ) const
inline

Definition at line 274 of file PRM_Type.h.

bool PRM_Type::isFloatType ( ) const
inline

Definition at line 270 of file PRM_Type.h.

bool PRM_Type::isOrdinalType ( ) const
inline

Definition at line 268 of file PRM_Type.h.

bool PRM_Type::isStringType ( ) const
inline

Definition at line 272 of file PRM_Type.h.

bool PRM_Type::isSwitcher ( ) const
inline

Definition at line 280 of file PRM_Type.h.

bool PRM_Type::isVisible ( ) const
inline

Definition at line 276 of file PRM_Type.h.

bool PRM_Type::loadBinary ( UT_IStream is)
PRM_Type::operator bool ( ) const
inline

Definition at line 1012 of file PRM_Type.h.

bool PRM_Type::operator!= ( const PRM_Type t) const
inline

Definition at line 1006 of file PRM_Type.h.

void PRM_Type::operator&= ( const PRM_Type t)
inline

Definition at line 1040 of file PRM_Type.h.

const PRM_Type & PRM_Type::operator= ( const PRM_Type t)
inline

Definition at line 976 of file PRM_Type.h.

bool PRM_Type::operator== ( const PRM_Type t) const
inline

Definition at line 992 of file PRM_Type.h.

void PRM_Type::operator|= ( const PRM_Type t)
inline

Definition at line 1026 of file PRM_Type.h.

void PRM_Type::saveASCII ( std::ostream &  os) const
void PRM_Type::saveBinary ( std::ostream &  os) const
void PRM_Type::stripUiType ( )
inline

Definition at line 1068 of file PRM_Type.h.

Friends And Related Function Documentation

const PRM_Type operator& ( const PRM_Type t1,
const PRM_Type t2 
)
friend

Definition at line 1198 of file PRM_Type.h.

const PRM_Type operator| ( const PRM_Type t1,
const PRM_Type t2 
)
friend

Definition at line 1183 of file PRM_Type.h.

const PRM_Type operator~ ( const PRM_Type t1)
friend

Definition at line 1213 of file PRM_Type.h.

const PRM_Type PRM_STRIP_UI_TYPE ( const PRM_Type t1)
friend

Definition at line 1228 of file PRM_Type.h.


The documentation for this class was generated from the following file: