PI_StateTemplate Class Reference

#include <PI_ResourceTemplate.h>

Inheritance diagram for PI_StateTemplate:

PI_ResourceTemplate

List of all members.

Public Member Functions

 PI_StateTemplate (const char *name, const char *english, const char *icon_name, void *constructor, PRM_Template *templates, PI_ViewerType viewer_type, unsigned network_types, int op_independent=1, const char *volatile_hotkey=0, OP_Operator *op=0)
virtual ~PI_StateTemplate ()
void initialize (const char *name, const char *english, const char *icon_name, void *constructor, PRM_Template *templates, PI_ViewerType viewer_type, unsigned network_types, int op_independent=1, const char *volatile_hotkey=0, bool hidden=false)
PRM_Templatetemplates ()
const PRM_Templatetemplates () const
PI_ViewerType viewerType () const
unsigned networkTypes () const
const char * getIconName () const
int opIndependent () const
int volatileKey () const
int volatileKeyModifiers () const
const char * getHotkeyString () const
OP_OperatorgetOperator () const
void setHidden (bool hide)
bool getHidden () const

Protected Member Functions

void setVolatileKey (int key, int modifiers)


Detailed Description

Examples:

SOP/MSS_BrushHairLen.C, SOP/MSS_BrushHairLen.h, SOP/MSS_CustomBrushState.C, and SOP/MSS_CustomBrushState.h.

Definition at line 88 of file PI_ResourceTemplate.h.


Constructor & Destructor Documentation

PI_StateTemplate::PI_StateTemplate ( const char *  name,
const char *  english,
const char *  icon_name,
void *  constructor,
PRM_Template templates,
PI_ViewerType  viewer_type,
unsigned  network_types,
int  op_independent = 1,
const char *  volatile_hotkey = 0,
OP_Operator op = 0 
)

virtual PI_StateTemplate::~PI_StateTemplate (  )  [virtual]


Member Function Documentation

bool PI_StateTemplate::getHidden (  )  const [inline]

Definition at line 136 of file PI_ResourceTemplate.h.

const char* PI_StateTemplate::getHotkeyString (  )  const [inline]

Definition at line 129 of file PI_ResourceTemplate.h.

const char* PI_StateTemplate::getIconName (  )  const [inline]

Definition at line 121 of file PI_ResourceTemplate.h.

OP_Operator* PI_StateTemplate::getOperator (  )  const [inline]

Definition at line 131 of file PI_ResourceTemplate.h.

void PI_StateTemplate::initialize ( const char *  name,
const char *  english,
const char *  icon_name,
void *  constructor,
PRM_Template templates,
PI_ViewerType  viewer_type,
unsigned  network_types,
int  op_independent = 1,
const char *  volatile_hotkey = 0,
bool  hidden = false 
)

unsigned PI_StateTemplate::networkTypes (  )  const [inline]

Definition at line 119 of file PI_ResourceTemplate.h.

int PI_StateTemplate::opIndependent (  )  const [inline]

Definition at line 123 of file PI_ResourceTemplate.h.

void PI_StateTemplate::setHidden ( bool  hide  )  [inline]

Definition at line 134 of file PI_ResourceTemplate.h.

void PI_StateTemplate::setVolatileKey ( int  key,
int  modifiers 
) [inline, protected]

Definition at line 140 of file PI_ResourceTemplate.h.

const PRM_Template* PI_StateTemplate::templates (  )  const [inline]

Definition at line 115 of file PI_ResourceTemplate.h.

PRM_Template* PI_StateTemplate::templates (  )  [inline]

Definition at line 114 of file PI_ResourceTemplate.h.

PI_ViewerType PI_StateTemplate::viewerType (  )  const [inline]

Definition at line 117 of file PI_ResourceTemplate.h.

int PI_StateTemplate::volatileKey (  )  const [inline]

Definition at line 125 of file PI_ResourceTemplate.h.

int PI_StateTemplate::volatileKeyModifiers (  )  const [inline]

Definition at line 127 of file PI_ResourceTemplate.h.


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

Generated on Mon Jan 28 00:48:41 2013 for HDK by  doxygen 1.5.9