PRM/PRM_Template.h File Reference

#include "PRM_API.h"
#include <UT/UT_IntArray.h>
#include <UT/UT_PtrArray.h>
#include <UT/UT_String.h>
#include "PRM_DisableList.h"
#include "PRM_Name.h"
#include "PRM_Type.h"

Go to the source code of this file.

Classes
class	PRM_Template
Defines
#define	PRM_TYPE_IS_SWITCHER(type)   (type.isSwitcher())
#define	PRM_IS_JOIN(parm)
Typedefs
typedef int(*	PRM_Callback )(void *data, int index, float time, const PRM_Template *tplate)
Variables
PRM_API PRM_ChoiceList	PRMtoggleMenu

---

Define Documentation

#define PRM_IS_JOIN

(

parm

)

Value:

(parm.getTypeExtended() == PRM_TYPE_TOGGLE_JOIN || \
                       parm.getTypeExtended() == PRM_TYPE_JOIN_PAIR)

Definition at line 38 of file PRM_Template.h.

#define PRM_TYPE_IS_SWITCHER

(

type

)

(type.isSwitcher())

Definition at line 36 of file PRM_Template.h.

---

Typedef Documentation

typedef int(* PRM_Callback)(void *data, int index, float time, const PRM_Template *tplate)

This is a callback function that can be used to modify data. It is invoked when the user uses a parameter of type PRM_CALLBACK (this might be a button, or a menu).

Parameters:

	data	Pointer to the node it was called on
	index	The index of the menu entry
	time	Current evaluation time
	tplate	Pointer to the PRM_Template of the parameter it was triggered for.

Returns:

It should return 1 if you want the dialog to refresh (ie if you changed any values) and 0 otherwise.

Definition at line 59 of file PRM_Template.h.

---

Variable Documentation

PRM_API PRM_ChoiceList PRMtoggleMenu