Callbacks/Handlers

Detailed Description

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 void(*	BrowserPopupCallback) (void *userdata, Int32 cmd, SDKBrowserURL &url, const maxon::Id &assetId)
typedef Bool(*	BaseDrawMessageHook) (BaseDraw *pBaseDraw, BaseDocument *pDoc, BASEDRAW_HOOK_MESSAGE msg, void *pData)
typedef void	ThreadMain(void *data)
typedef Bool	ThreadTest(void *data)
typedef const Char *	ThreadName(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 maxon::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(*	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 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]	sd	The volume data for the point being calculated.
[in]	rlc	The light data cache for the point being calculated.
[in]	dat	The private data sent to IlluminanceSimple().

BrowserPopupCallback

typedef void(* BrowserPopupCallback) (void *userdata, Int32 cmd, SDKBrowserURL &url, const maxon::Id &assetId)

Callback for BrowserLibraryPopup().

Parameters

[in]	userdata	The data sent to BrowserLibraryPopup().
[in]	cmd	The browser command ID.
[in]	url	The URL of the preset.

BaseDrawMessageHook

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

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]	p	The progress, between 0.0 and 1.0.
[in]	progress_type	The render progress type: RENDERPROGRESSTYPE
[in]	context	The 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 maxon::String &streamname, void *context)

Callback for the write progress of RenderDocument().

See also

RenderJob::GetWriteProgressHook
NetRenderService::InitRendering

Parameters

[in]	mode	The write mode.
[in]	bmp	The bitmap written to.
[in]	mainImage	true for main image, otherwise false.
[in]	frame	The frame number.
[in]	renderTime	The bitmap frame time.
[in]	streamnum	The stream number.
[in]	streamname	The stream name.
[in]	context	The context data passed. The caller owns the pointed data.

BakeProgressHook

typedef void BakeProgressHook(BakeProgressInfo *info)

Callback for the progress of texture baking.

Parameters

[in]

info

The 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.

LASTCURSORINFOFUNC

typedef void(* LASTCURSORINFOFUNC) ()

Callback invoked when mouse cursor leaves a user area.

See also

RemoveLastCursorInfo()

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)
  {
    case BACKGROUNDHANDLERCOMMAND::ISRUNNING:
    {
      return world->materialpreview && world->materialpreview->IsRunning();
    } break;
 
    case BACKGROUNDHANDLERCOMMAND::STOP:
    {
      if (flags&BACKGROUNDHANDLERFLAGS::MATERIALPREVIEW)
      {
        if (world->materialpreview)
          world->materialpreview->End();
      }
    } break;
 
    case BACKGROUNDHANDLERCOMMAND::START:
    {
      return CheckActiveMaterialPreview(world->GetActiveDocument());
    } break;
  }
  return true;
}

Parameters

[in]	data	The data passed to GeAddBackgroundHandler()
[in]	command	The callback command: BACKGROUNDHANDLERCOMMAND
[in]	parm	The 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]

crashinfo

The 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]	obj	The object the source belongs to.
[in]	msg	The message container.

Returns

A GeData depending on the message.