BaseInterface Class Reference
 
 
 
BaseInterface Class Reference

#include <baseinterface.h>

Inheritance diagram for BaseInterface:
InterfaceServer MaxHeapOperators BezierShapeInterface_Ex41 BitmapIOLayer BitmapIOMetaData Effect8 FPInterface IActionItemStandin IActionManager10 IActionOptions IAreaShadowType IAttachCtrl IBaseGrip IColorSwatchRenamer ID3D10GraphicsWindow ID3D10HardwareRenderer ID3D10ShaderResource ID3D9GraphicsWindow ID3DHWMeshCacheManager IDaylightControlledLightSystem IDX8PixelShader IDX8VertexShader IDX9PixelShader IDX9VertexShader IDXDataBridge IEffectFile IEmissionColor IFaceDataMgr IGeometryChecker IHardwareMaterial IHardwareMesh IHardwareMNMesh IHardwareShader IIlluminationComponents IIKGoal ILockedContainerUpdate IMaterial IMaterialViewportShading IMNMeshUtilities10 IMNMeshUtilities13 IMNMeshUtilities8 IMNTempData10 imrGeomShaderTranslation imrLightTranslation IMRPhysicalSkyEnvironmentMap IMRPhysicalSkyInterface IMRPhysicalSunLight imrShader imrShaderTranslation IMrSkyPortalLight IMtlBrowserFilter INewSubTexmapNotification INodeValidity IOsnapManager IParamBlock2PostLoadInfo IPFViewportExtension2 IPFViewportExtention IPipelineClient IProjection_WorkingModelInfo IProjectionModData IRadiosityEffectExtension IRadiosityRenderParameters IRenderElementRequirements IRendererRequirements IRTShaderParameterBinding ISceneCallbackPriority ISceneEventCallback ISceneEventManager ISceneTraversal IShadeContextExtension8 ISkyLight ISpecularCompositeShader ISplineIKControl2 ISubMtlMap_BrowserFilter ISunLight ISunLightPosition ITabDialogFilter ITabDialogObject ITabDialogPluginTab ITabDialogProc ITabPage ITimeBasedConverter IToneOperatorExtension ITrackBarFilterManager IViewPanel IXTCAccess LightscapeLight::AreaLightCustAttrib IAddRenderItemsHelper IHLSLMaterialTranslator IMeshDisplay2 IObjectDisplay IObjectDisplay2 IParameterTranslator IShaderManager ISimpleMaterial ITextureDisplay MeshSelectionConverter NodeDisplayCallbackEx SkyLightEval ToneOperatorInvertable

Class Description

See also:
Class InterfaceServer, Class InterfaceNotifyCallback, Class FPInterface, Function Publishing System.

Description:
This class represents the base class for interfaces in 3ds Max. The BaseInterface class should be used as the base class for any new interface class in 3ds Max and provides basic identity, memory management, and cloning methods. Class FPInterface, which is part of the Function Publishing system, has the BaseInterface class as its base class.

Public Types

enum   LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions

virtual UtilExport  ~BaseInterface ()
  Destructor.
UtilExport BaseInterface GetInterface (Interface_ID id)
virtual UtilExport Interface_ID  GetID ()
virtual LifetimeType  LifetimeControl ()
virtual bool  RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void  UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface AcquireInterface ()
virtual void  ReleaseInterface ()
virtual void  DeleteInterface ()
virtual BaseInterface CloneInterface (void *remapDir=NULL)

Member Enumeration Documentation


Constructor & Destructor Documentation

virtual UtilExport ~BaseInterface ( ) [virtual]

Destructor.


Member Function Documentation

virtual UtilExport Interface_ID GetID ( ) [virtual]
Remarks:
This method returns the unique interface ID.

Reimplemented in IActionOptions, ActionItem, IActionItemStandin, ActionTable, IActionManager10, AssetUser, IColorSwatchRenamer, IHLSLMaterialTranslator, IMeshDisplay2, IObjectDisplay, IObjectDisplay2, IParameterTranslator, IShaderManager, ITextureDisplay, ID3D9GraphicsWindow, IDaylightControlledLightSystem, IDaylightSystem2, ID3D10HardwareRenderer, ID3D10GraphicsWindow, ID3D10ShaderResource, IDX8PixelShader, IDX8VertexShader, IDX9PixelShader, IDX9VertexShader, IEmissionColor, IFaceDataMgr, FPInterfaceDesc, FPMixinInterface, IBaseGrip2, IHardwareMaterial, IHardwareMesh, IHardwareMNMesh, IHardwareRenderer, IHardwareRendererST, ID3DHWMeshCacheManager, IHardwareShader, IIKGoal, IHIIKGoal, ISplineIKGoal, ISplineIKGoal2, ILockedContainerUpdate, IMaterialBrowserEntryInfo, IMaterialViewportShading, INewSubTexmapNotification, IMtlBrowserFilter, ISubMtlMap_BrowserFilter, INodeMonitor, INodeTransformMonitor, INodeValidity, IParamBlock2PostLoadInfo, IPipelineClient, IProjection_WorkingModelInfo, IProjectionModData, IRefTargMonitorClass, IRTShaderParameterBinding, INodeEventCallback, IShadeContextExtension8, ILookatControl_Extension, ITreeViewUI, ITreeViewOps, IViewPanel, IDXDataBridge, IDX9DataBridge, LightscapeLight::AreaLightCustAttrib, IMRPhysicalSkyEnvironmentMap, IMRPhysicalSkyInterface, IMRPhysicalSkyInterface2, IMRPhysicalSunLight, imrShader, imrShaderTranslation, imrMaterialPhenomenonTranslation, imrGeomShaderTranslation, IMrSkyPortalLight, MeshSelectionConverter, MeshNormalSpec, IMNTempData10, IMNMeshUtilities8, IMNMeshUtilities10, IMNMeshUtilities13, MNNormalSpec, IXTCAccess, ITimeBasedConverter, IRadiosityEffectExtension, IRadiosityRenderParameters, IRendererRequirements, IRenderElementRequirements, IEffectFile, BezierShapeInterface_Ex41, IToneOperatorExtension, IXRefAtmospheric, IXRefCtrl, IXRefItem, IXRefMaterial, IXRefObject8, IObjXRefRecord, and IXRefProxy.

virtual LifetimeType LifetimeControl ( ) [inline, virtual]
Remarks:
This method allows inquiries into the actual lifetime policy of a client and provide a server-controlled delete notify callback.
Returns:
One of the following LifetimeTypes:

noRelease

Do not call release, use interface as long as you like.

immediateRelease

The interface is only good for one calls. The release is implied so a call to release is not required.

wantsRelease

The clients are controlling the lifetime, so the interface needs a Release() when the client has finished. This is the default.

serverControlled

The server controls the lifetime and will use the InterfaceNotifyCallback to inform the code when it is gone.
Default Implementation:
{ return noRelease; }

Reimplemented in AssetUser, ID3D9GraphicsWindow, IEmissionColor, FPInterfaceDesc, FPMixinInterface, IHardwareMaterial, IHardwareMesh, IHardwareMNMesh, IHardwareRenderer, ID3DHWMeshCacheManager, IHardwareShader, IIKGoal, INodeValidity, IDXDataBridge, IDX9DataBridge, Plane, GizmoShape, IXTCAccess, XMLAnimTreeEntry, XMLAnimTreeEntryList, and NodeAndAnims.

{ return noRelease; }
virtual bool RegisterNotifyCallback ( InterfaceNotifyCallback incb ) [inline, virtual]
Remarks:
This method allows you to register an interface notify callback.
Parameters:
InterfaceNotifyCallback* incb

A pointer to the interface notify callback.
Default Implementation:
{ return false; }

Reimplemented in FPMixinInterface.

{ UNUSED_PARAM(incb); return false; }
virtual void UnRegisterNotifyCallback ( InterfaceNotifyCallback incb ) [inline, virtual]
Remarks:
This method allows you to un-register an interface notify callback.
Parameters:
InterfaceNotifyCallback incb

A pointer to the interface notify callback.
Default Implementation:
{ }

Reimplemented in FPMixinInterface.

{ UNUSED_PARAM(incb); }
virtual BaseInterface* AcquireInterface ( ) [inline, virtual]
Remarks:
This method is part of the interface reference management and can be implemented by dynamically allocated interfaces for ref-count based lifetime control). This method should return TRUE if it needs Release() to be called.
Default Implementation:
{ return false; }

Reimplemented in Plane, GizmoShape, XMLAnimTreeEntry, XMLAnimTreeEntryList, and NodeAndAnims.

{ return (BaseInterface*)this; }; 
virtual void ReleaseInterface ( ) [inline, virtual]
Remarks:
This method is called when a reference to this object is deleted.
Default Implementation:
{ }

Reimplemented in IIKGoal, Plane, GizmoShape, XMLAnimTreeEntry, XMLAnimTreeEntryList, and NodeAndAnims.

{ };
virtual void DeleteInterface ( ) [inline, virtual]
Remarks:
This method can be used as a direct interface delete request.
Default Implementation:
{ }

Reimplemented in IAddRenderItemsHelper, INodeValidity, MeshSelectionConverter, MeshNormalSpec, MNNormalSpec, and BezierShapeInterface_Ex41.

{ };
virtual BaseInterface* CloneInterface ( void *  remapDir = NULL ) [inline, virtual]
Remarks:
This method allows you to clone the base interface.
Parameters:
void* remapDir

The RemapDir passed to the clone method.
Default Implementation:
{ return NULL; }

Reimplemented in MeshSelectionConverter, MeshNormalSpec, and MNNormalSpec.

{ UNUSED_PARAM(remapDir); return NULL; }