Callbacks/Handlers

Detailed Description

Groups

 Extended OpenGL Mode
 

Namespaces

 maxon
 

Typedefs

typedef Int32 CDialogMessage(CDialog *cd, CUserArea *cu, BaseContainer *msg)
 
typedef void ListViewCallBack(Int32 &res_type, void *&result, void *userdata, void *secret, Int32 cmd, Int32 line, Int32 col, void *data1)
 
typedef void IlluminationModel(VolumeData *sd, RayLightCache *rlc, void *dat)
 
typedef Bool COFFEE_ERRORHANDLER(void *priv_data, const BaseContainer &bc)
 
typedef void(* BrowserPopupCallback) (void *userdata, Int32 cmd, SDKBrowserURL &url)
 
typedef Bool(* BaseDrawMessageHook) (BaseDraw *pBaseDraw, BaseDocument *pDoc, BASEDRAW_HOOK_MESSAGE msg, void *pData)
 
typedef ZEROCONFACTION(* ZeroConfBrowserCallback) (const String &serviceName, Int32 lInterface, ZEROCONFMACHINESTATE state, Bool moreComing, ZEROCONFERROR error, void *context)
 
typedef void(* ZeroConfBrowserResolvedCallback) (const String &serviceName, const String &fullyQualifiedDomainName, Int32 port, Int32 lInterface, Bool txtRecordUpdate, const String *keys, const String *values, Int32 count, ZEROCONFERROR error, void *context)
 
typedef void ThreadMain(void *data)
 
typedef Bool ThreadTest(void *data)
 
typedef const CharThreadName(void *data)
 
typedef void ProgressHook(Float p, RENDERPROGRESSTYPE progress_type, void *context)
 
typedef void WriteProgressHook(WRITEMODE mode, BaseBitmap *bmp, const Filename &fn, Bool mainImage, Int32 frame, Int32 renderTime, Int32 streamnum, const String &streamname, void *context)
 
typedef void BakeProgressHook(BakeProgressInfo *info)
 
typedef void * HierarchyAlloc(void *main)
 
typedef void HierarchyFree(void *main, void *data)
 
typedef void HierarchyCopyTo(void *main, void *src, void *dst)
 
typedef Bool HierarchyDo(void *main, void *data, BaseObject *op, const Matrix &mg, Bool controlobject)
 
typedef void PopupEditTextCallback(Int32 mode, const String &text, void *userdata)
 
typedef void(* LASTCURSORINFOFUNC) ()
 
typedef Bool(* SaveCallbackImageFunc) (RDATA_SAVECALLBACK_CMD cmd, void *userdata, BaseDocument *doc, Int32 framenum, BaseBitmap *bmp, const Filename &fn)
 
typedef Bool BackgroundHandler(void *data, BACKGROUNDHANDLERCOMMAND command, BACKGROUNDHANDLERFLAGS parm)
 
typedef void(* C4D_CrashHandler) (Char *crashinfo)
 
typedef void(* C4D_CreateOpenGLContext) (void *context, void *root, UInt32 flags)
 
typedef void(* C4D_DeleteOpenGLContext) (void *context, UInt32 flags)
 
typedef GeData CodeEditorCallback(BaseList2D *obj, const BaseContainer &msg)
 
typedef void(* V_CODE) (Coffee *, VALUE *&, Int32)
 

Typedef Documentation

§ CDialogMessage

typedef Int32 CDialogMessage(CDialog *cd, CUserArea *cu, BaseContainer *msg)

Internal. dialog hook.

§ ListViewCallBack

typedef void ListViewCallBack(Int32 &res_type, void *&result, void *userdata, void *secret, Int32 cmd, Int32 line, Int32 col, void *data1)

Internal. listview hook.

§ IlluminationModel

typedef void IlluminationModel(VolumeData *sd, RayLightCache *rlc, void *dat)

Hook passed to IlluminanceSimple(). Called during illuminance calculations.

Parameters
[in]sdThe volume data for the point being calculated.
[in]rlcThe light data cache for the point being calculated.
[in]datThe private data sent to IlluminanceSimple().

§ COFFEE_ERRORHANDLER

typedef Bool COFFEE_ERRORHANDLER(void *priv_data, const BaseContainer &bc)

Callback for C.O.F.F.E.E. error handling.

Parameters
[in]priv_dataThe private data for the error handler, as passed to Coffee::InstallErrorHook().
[in]bcThe error container with the following IDs:
  • 1: Error number.
  • 2: Error line.
  • 3: Error position.
  • 4: Error file.
  • 5: Error string.
Returns
true if the error should be passed along to the default console output, otherwise false.

§ BrowserPopupCallback

typedef void(* BrowserPopupCallback) (void *userdata, Int32 cmd, SDKBrowserURL &url)

Callback for BrowserLibraryPopup().

Parameters
[in]userdataThe data sent to BrowserLibraryPopup().
[in]cmdThe browser command ID.
[in]urlThe URL of the preset.

§ BaseDrawMessageHook

typedef Bool(* BaseDrawMessageHook) (BaseDraw *pBaseDraw, BaseDocument *pDoc, BASEDRAW_HOOK_MESSAGE msg, void *pData)

Private.

§ ZeroConfBrowserCallback

typedef ZEROCONFACTION(* ZeroConfBrowserCallback) (const String &serviceName, Int32 lInterface, ZEROCONFMACHINESTATE state, Bool moreComing, ZEROCONFERROR error, void *context)

Private.

§ ZeroConfBrowserResolvedCallback

typedef void(* ZeroConfBrowserResolvedCallback) (const String &serviceName, const String &fullyQualifiedDomainName, Int32 port, Int32 lInterface, Bool txtRecordUpdate, const String *keys, const String *values, Int32 count, ZEROCONFERROR error, void *context)

Private.

§ ThreadMain

typedef void ThreadMain(void *data)

Internal. thread hook.

§ ThreadTest

typedef Bool ThreadTest(void *data)

Internal. thread hook.

§ ThreadName

typedef const Char* ThreadName(void *data)

Internal. thread hook.

§ ProgressHook

typedef void ProgressHook(Float p, RENDERPROGRESSTYPE progress_type, void *context)

Callback for the progress of RenderDocument().

See also
RenderJob::GetProgressHook
NetRenderService::InitRendering
Parameters
[in]pThe progress, between 0.0 and 1.0.
[in]progress_typeThe render progress type: RENDERPROGRESSTYPE
[in]contextThe context passed to RenderDocument(). The caller owns the pointed context.

§ WriteProgressHook

typedef void WriteProgressHook(WRITEMODE mode, BaseBitmap *bmp, const Filename &fn, Bool mainImage, Int32 frame, Int32 renderTime, Int32 streamnum, const String &streamname, void *context)

Callback for the write progress of RenderDocument().

See also
RenderJob::GetWriteProgressHook
NetRenderService::InitRendering
Parameters
[in]modeThe write mode.
[in]bmpThe bitmap written to.
[in]mainImagetrue for main image, otherwise false.
[in]frameThe frame number.
[in]renderTimeThe bitmap frame time.
[in]streamnumThe stream number.
[in]streamnameThe stream name.
[in]contextThe context data passed. The caller owns the pointed data.

§ BakeProgressHook

typedef void BakeProgressHook(BakeProgressInfo *info)

Callback for the progress of texture baking.

Parameters
[in]infoThe bake progress information.

§ HierarchyAlloc

typedef void* HierarchyAlloc(void *main)

Internal. hierarchy hook.

§ HierarchyFree

typedef void HierarchyFree(void *main, void *data)

Internal. hierarchy hook.

§ HierarchyCopyTo

typedef void HierarchyCopyTo(void *main, void *src, void *dst)

Internal. hierarchy hook.

§ HierarchyDo

typedef Bool HierarchyDo(void *main, void *data, BaseObject *op, const Matrix &mg, Bool controlobject)

Internal. hierarchy hook.

§ PopupEditTextCallback

typedef void PopupEditTextCallback(Int32 mode, const String &text, void *userdata)

Callback for PopupEditText().

Parameters
[in]modeThe popup edit mode: POPUPEDITTEXTCALLBACK
[in]textThe edit text.
[in]userdataThe user data passed to PopupEditText().

§ LASTCURSORINFOFUNC

typedef void(* LASTCURSORINFOFUNC) ()

Private.

§ SaveCallbackImageFunc

typedef Bool(* SaveCallbackImageFunc) (RDATA_SAVECALLBACK_CMD cmd, void *userdata, BaseDocument *doc, Int32 framenum, BaseBitmap *bmp, const Filename &fn)

Private.

§ BackgroundHandler

typedef Bool BackgroundHandler(void *data, BACKGROUNDHANDLERCOMMAND command, BACKGROUNDHANDLERFLAGS parm)

Callback for background handlers registered with GeAddBackgroundHandler()
Example from the active material rendering:

Bool Handler_ActiveMaterial(void *data, Int32 command, Int32 flags)
{
switch (command)
{
{
return world->materialpreview && world->materialpreview->IsRunning();
} break;
{
{
if (world->materialpreview)
world->materialpreview->End();
}
} break;
{
return CheckActiveMaterialPreview(world->GetActiveDocument());
} break;
}
return true;
}
Parameters
[in]dataThe data passed to GeAddBackgroundHandler()
[in]commandThe callback command: BACKGROUNDHANDLERCOMMAND
[in]parmThe flags given to GeStopBackgroundThreads(): BACKGROUNDHANDLERFLAGS
Returns
Depends on the background handler command.

§ C4D_CrashHandler

typedef void(* C4D_CrashHandler) (Char *crashinfo)

A custom crash handler.
See the SDK examples and main.cpp.

Parameters
[in]crashinfoThe crash information text.

§ C4D_CreateOpenGLContext

typedef void(* C4D_CreateOpenGLContext) (void *context, void *root, UInt32 flags)

Create OpenGL context hook.

§ C4D_DeleteOpenGLContext

typedef void(* C4D_DeleteOpenGLContext) (void *context, UInt32 flags)

Delete OpenGL context hook.

§ CodeEditorCallback

typedef GeData CodeEditorCallback(BaseList2D *obj, const BaseContainer &msg)

Callback for CodeEditor_Open().

Parameters
[in]objThe object the source belongs to.
[in]msgThe message container.
Returns
A GeData depending on the message.

§ V_CODE

typedef void(* V_CODE) (Coffee *, VALUE *&, Int32)

Callback for C.O.F.F.E.E. definitions.