Pointwise Plugin SDK
Modules | Classes | Macros | Typedefs | Enumerations
+ Collaboration diagram for Data Types:

Modules

 Data Handle Helper Macros
 
 Published Variable Attribute Groups
 

Classes

struct  PWP_APIINFO
 The API information returned by plugins for each supported API. More...
 
struct  PWP_HVALUE_IMPL
 
struct  PWP_HVALUE
 An opaque handle to a value. More...
 
struct  PWP_LICENSEDATA
 Installation's license data. NOT IMPLEMENTED YET. More...
 
struct  PWP_MSG_PROGRESS
 The data sent by plugins for progress messages. More...
 
struct  PWP_MSG_TEXT
 The data sent by plugins for text messages. More...
 
struct  PWP_PLUGININFO
 Provides general information about a plugin. More...
 
struct  PWP_VERSION
 Version data. More...
 

Macros

#define PWP_HVALUE_GET_IMPL(h)   PWP_HANDLE_GET_IMPL(h, PWP_HVALUE)
 obtains the underlying PWP_HVALUE_IMPL ptr from the handle More...
 
#define PWP_HVALUE_INIT   PWP_HANDLE_INIT
 static data init value More...
 
#define PWP_HVALUE_ISVALID(h)   PWP_HANDLE_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWP_HVALUE_SET(h, v)   PWP_HANDLE_SET(h, v)
 assigns internal handle values More...
 
#define PWP_HVALUE_SET_IMPL(h, hTyp)   PWP_HANDLE_SET_IMPL(h, PWP_HVALUE, hTyp)
 assigns internal handle values using an implementation More...
 
#define PWP_HVALUE_SET_INVALID(h)   PWP_HVALUE_SET(h, PWP_HANDLE_INIT)
 resets handle to an invalid state More...
 
#define PWP_MESSAGECB_DEFAULT   "@@default"
 Special API name used to register the default message handler. More...
 
#define PWP_MESSAGECB_SPY   "@@spy"
 Special API name used to register the spy message handler. More...
 

Typedefs

typedef PWP_UINT32(* PWP_MESSAGECB) (const char api[], PWP_ENUM_MSGID id, void *pMsg)
 Message handler callback function signature. More...
 
typedef PWP_UINT32 PWP_VERSIONVAL
 Version data component value. More...
 
typedef PWP_BOOL PwpValue_t(const void *dest, PWP_ENUM_VALTYPE srcType, const void *srcValue, PWP_UINT32 srcSize)
 Value transfer callback function signature. More...
 

Enumerations

enum  PWP_ENDIANNESS {
  PWP_ENDIAN_ERROR,
  PWP_ENDIAN_NATIVE,
  PWP_ENDIAN_FOREIGN,
  PWP_ENDIAN_LITTLE,
  PWP_ENDIAN_BIG
}
 Flags used to indicate endianness or control endian behaviors in functions. More...
 
enum  PWP_ENUM_DIMENSION {
  PWP_DIMENSION_2D,
  PWP_DIMENSION_3D
}
 Supported dimensionality values. More...
 
enum  PWP_ENUM_ENCODING {
  PWP_ENCODING_ASCII,
  PWP_ENCODING_BINARY,
  PWP_ENCODING_UNFORMATTED
}
 File encoding values. More...
 
enum  PWP_ENUM_FILEDEST {
  PWP_FILEDEST_FILENAME,
  PWP_FILEDEST_BASENAME,
  PWP_FILEDEST_FOLDER
}
 File destination types. More...
 
enum  PWP_ENUM_MSGID {
  PWP_MSGID_DEBUG,
  PWP_MSGID_INFO,
  PWP_MSGID_WARNING,
  PWP_MSGID_ERROR,
  PWP_MSGID_PROGBEGIN,
  PWP_MSGID_PROGEND,
  PWP_MSGID_PROGSTATUS,
  PWP_MSGID_PROGQUIT
}
 Supported PWP-API message ids. More...
 
enum  PWP_ENUM_PRECISION {
  PWP_PRECISION_SINGLE,
  PWP_PRECISION_DOUBLE
}
 File precision values. More...
 
enum  PWP_ENUM_VALTYPE {
  PWP_VALTYPE_STRING,
  PWP_VALTYPE_INT,
  PWP_VALTYPE_UINT,
  PWP_VALTYPE_REAL,
  PWP_VALTYPE_ENUM,
  PWP_VALTYPE_BOOL
}
 Supported PWP-API getValue() transfer types. More...
 

Detailed Description

Macro Definition Documentation

◆ PWP_HVALUE_GET_IMPL

#define PWP_HVALUE_GET_IMPL (   h)    PWP_HANDLE_GET_IMPL(h, PWP_HVALUE)

obtains the underlying PWP_HVALUE_IMPL ptr from the handle

Definition at line 378 of file apiPWP.h.

Referenced by PwuValueSetter().

◆ PWP_HVALUE_INIT

#define PWP_HVALUE_INIT   PWP_HANDLE_INIT

static data init value

Definition at line 366 of file apiPWP.h.

◆ PWP_HVALUE_ISVALID

#define PWP_HVALUE_ISVALID (   h)    PWP_HANDLE_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 363 of file apiPWP.h.

Referenced by PwpGetValue().

◆ PWP_HVALUE_SET

#define PWP_HVALUE_SET (   h,
 
)    PWP_HANDLE_SET(h, v)

assigns internal handle values

Definition at line 369 of file apiPWP.h.

◆ PWP_HVALUE_SET_IMPL

#define PWP_HVALUE_SET_IMPL (   h,
  hTyp 
)    PWP_HANDLE_SET_IMPL(h, PWP_HVALUE, hTyp)

assigns internal handle values using an implementation

Definition at line 375 of file apiPWP.h.

◆ PWP_HVALUE_SET_INVALID

#define PWP_HVALUE_SET_INVALID (   h)    PWP_HVALUE_SET(h, PWP_HANDLE_INIT)

resets handle to an invalid state

Definition at line 372 of file apiPWP.h.

◆ PWP_MESSAGECB_DEFAULT

#define PWP_MESSAGECB_DEFAULT   "@@default"

Special API name used to register the default message handler.

This special API name can be passed to PwpSetMessageCallback(api).

The default handler is only invoked if an API specific handler was not set.

See also
PWP_ENUM_MSGID, PWP_MESSAGECB, PwpSetMessageCallback, PwpGetMessageCallback

Definition at line 484 of file apiPWP.h.

Referenced by PwuSendMsg().

◆ PWP_MESSAGECB_SPY

#define PWP_MESSAGECB_SPY   "@@spy"

Special API name used to register the spy message handler.

This special API name can be passed to PwpSetMessageCallback(api).

The spy handler is always invoked after the API specific or default handler is invoked. The spy handler cannot modify the return value.

See also
PWP_ENUM_MSGID, PWP_MESSAGECB, PwpSetMessageCallback, PwpGetMessageCallback

Definition at line 497 of file apiPWP.h.

Referenced by PwuSendMsg().

Typedef Documentation

◆ PWP_MESSAGECB

typedef PWP_UINT32(* PWP_MESSAGECB) (const char api[], PWP_ENUM_MSGID id, void *pMsg)

Message handler callback function signature.

See also
PWP_ENUM_MSGID, PwpSetMessageCallback, PwpGetMessageCallback

Definition at line 471 of file apiPWP.h.

◆ PWP_VERSIONVAL

Version data component value.

See also
PWP_VERSION

Definition at line 385 of file apiPWP.h.

◆ PwpValue_t

typedef PWP_BOOL PwpValue_t(const void *dest, PWP_ENUM_VALTYPE srcType, const void *srcValue, PWP_UINT32 srcSize)

Value transfer callback function signature.

See also
PWP_ENUM_VALTYPE

Definition at line 639 of file apiPWP.h.

Enumeration Type Documentation

◆ PWP_ENDIANNESS

Flags used to indicate endianness or control endian behaviors in functions.

Enumerator
PWP_ENDIAN_ERROR 

error indicator

PWP_ENDIAN_NATIVE 

use native platform endian

PWP_ENDIAN_FOREIGN 

force opposite of native platform endian

PWP_ENDIAN_LITTLE 

force little-endian

PWP_ENDIAN_BIG 

force big-endian

Definition at line 738 of file apiPWP.h.

◆ PWP_ENUM_DIMENSION

Supported dimensionality values.

Enumerator
PWP_DIMENSION_2D 

Plugin supports 2D export

PWP_DIMENSION_3D 

Plugin supports 3D export

Definition at line 679 of file apiPWP.h.

◆ PWP_ENUM_ENCODING

File encoding values.

Enumerator
PWP_ENCODING_ASCII 

Plugin supports ASCII export

PWP_ENCODING_BINARY 

Plugin supports binary export

PWP_ENCODING_UNFORMATTED 

Plugin supports Unformatted export

Definition at line 698 of file apiPWP.h.

◆ PWP_ENUM_FILEDEST

File destination types.

Enumerator
PWP_FILEDEST_FILENAME 

/the/path/to/the/full_filename.ext

PWP_FILEDEST_BASENAME 

/the/path/to/the/base_filename (no ext)

PWP_FILEDEST_FOLDER 

/the/path/to/the/folder_name/ (no filename)

Definition at line 659 of file apiPWP.h.

◆ PWP_ENUM_MSGID

Supported PWP-API message ids.

See also
PWP_MESSAGECB, PwpSetMessageCallback, PwpGetMessageCallback
Enumerator
PWP_MSGID_DEBUG 

Debug text message id (see PWP_MSG_TEXT)

PWP_MSGID_INFO 

Information text message id (see PWP_MSG_TEXT)

PWP_MSGID_WARNING 

Non-fatal error text message id (see PWP_MSG_TEXT)

PWP_MSGID_ERROR 

Fatal error text message id (see PWP_MSG_TEXT)

PWP_MSGID_PROGBEGIN 

Begin progress message id (see PWP_MSG_PROGRESS)

PWP_MSGID_PROGEND 

End progress message id (see PWP_MSG_PROGRESS)

PWP_MSGID_PROGSTATUS 

Status progress message id (see PWP_MSG_PROGRESS)

PWP_MSGID_PROGQUIT 

Query progress quit message id (see PWP_MSG_PROGRESS)

Definition at line 420 of file apiPWP.h.

◆ PWP_ENUM_PRECISION

File precision values.

Enumerator
PWP_PRECISION_SINGLE 

Plugin supports single precision

PWP_PRECISION_DOUBLE 

Plugin supports double precision

Definition at line 718 of file apiPWP.h.

◆ PWP_ENUM_VALTYPE

Supported PWP-API getValue() transfer types.

See also
PwpValue_t
Enumerator
PWP_VALTYPE_STRING 

transfer value is a const char*

PWP_VALTYPE_INT 

transfer value is a PWP_INT

PWP_VALTYPE_UINT 

transfer value is a PWP_UINT

PWP_VALTYPE_REAL 

transfer value is a PWP_REAL

PWP_VALTYPE_ENUM 

transfer value is a const char*

PWP_VALTYPE_BOOL 

transfer value is a PWP_BOOL

Definition at line 612 of file apiPWP.h.