PRM_Callback Class Reference

#include <PRM_Callback.h>

Public Types
typedef int(*	PRM_Callback32 )(void *data, int index, fpreal32 time, const PRM_Template *tplate)
typedef int(*	PRM_Callback64 )(void *data, int index, fpreal64 time, const PRM_Template *tplate)
typedef int(*	PRM_CallbackOpt32 )(void *data, int index, fpreal32 time, const PRM_Template *tplate, const UT_Options *options)
typedef int(*	PRM_CallbackOpt64 )(void *data, int index, fpreal64 time, const PRM_Template *tplate, const UT_Options *options)

Public Member Functions
	PRM_Callback ()
	PRM_Callback (int ptr)
	PRM_Callback (long int ptr)
	PRM_Callback (std::nullptr_t)
	PRM_Callback (PRM_Callback32 cb)
	PRM_Callback (PRM_Callback64 cb)
	PRM_Callback (PRM_CallbackOpt32 cb)
	PRM_Callback (PRM_CallbackOpt64 cb)
int	operator() (void *data, int index, fpreal64 time, const PRM_Template *tplate)
int	operator() (void *data, int index, fpreal64 time, const PRM_Template *tplate, const UT_Options *options)
bool	operator== (const PRM_Callback &other)
bool	isNotNull () const
bool	isNull () const

Detailed Description

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 33 of file PRM_Callback.h.

Member Typedef Documentation

typedef int(* PRM_Callback::PRM_Callback32)(void *data, int index, fpreal32 time, const PRM_Template *tplate)

Definition at line 36 of file PRM_Callback.h.

typedef int(* PRM_Callback::PRM_Callback64)(void *data, int index, fpreal64 time, const PRM_Template *tplate)

Definition at line 38 of file PRM_Callback.h.

typedef int(* PRM_Callback::PRM_CallbackOpt32)(void *data, int index, fpreal32 time, const PRM_Template *tplate, const UT_Options *options)

Definition at line 40 of file PRM_Callback.h.

typedef int(* PRM_Callback::PRM_CallbackOpt64)(void *data, int index, fpreal64 time, const PRM_Template *tplate, const UT_Options *options)

Definition at line 43 of file PRM_Callback.h.

Constructor & Destructor Documentation

PRM_Callback::PRM_Callback ( )

inline

Definition at line 47 of file PRM_Callback.h.

PRM_Callback::PRM_Callback ( int  ptr )

inline

Definition at line 52 of file PRM_Callback.h.

PRM_Callback::PRM_Callback ( long int  ptr )

inline

Definition at line 57 of file PRM_Callback.h.

PRM_Callback::PRM_Callback ( std::nullptr_t  )

inline

Definition at line 62 of file PRM_Callback.h.

PRM_Callback::PRM_Callback ( PRM_Callback32  cb )

inline

Definition at line 66 of file PRM_Callback.h.

PRM_Callback::PRM_Callback ( PRM_Callback64  cb )

inline

Definition at line 71 of file PRM_Callback.h.

PRM_Callback::PRM_Callback ( PRM_CallbackOpt32  cb )

inline

Definition at line 76 of file PRM_Callback.h.

PRM_Callback::PRM_Callback ( PRM_CallbackOpt64  cb )

inline

Definition at line 81 of file PRM_Callback.h.

Member Function Documentation

bool PRM_Callback::isNotNull ( ) const

inline

Definition at line 143 of file PRM_Callback.h.

bool PRM_Callback::isNull ( ) const

inline

Definition at line 159 of file PRM_Callback.h.

int PRM_Callback::operator() ( void *  data, int  index, fpreal64  time, const PRM_Template *  tplate  )

inline

Definition at line 87 of file PRM_Callback.h.

int PRM_Callback::operator() ( void *  data, int  index, fpreal64  time, const PRM_Template *  tplate, const UT_Options *  options  )

inline

Definition at line 105 of file PRM_Callback.h.

bool PRM_Callback::operator== ( const PRM_Callback &  other )

inline

Definition at line 124 of file PRM_Callback.h.

Member Data Documentation

PRM_Callback32 PRM_Callback::myCallback32

Definition at line 175 of file PRM_Callback.h.

PRM_Callback64 PRM_Callback::myCallback64

Definition at line 174 of file PRM_Callback.h.

PRM_CallbackOpt32 PRM_Callback::myCallbackOpt32

Definition at line 177 of file PRM_Callback.h.

PRM_CallbackOpt64 PRM_Callback::myCallbackOpt64

Definition at line 176 of file PRM_Callback.h.

---

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

• PRM/PRM_Callback.h