BaseInterface Class Reference

This reference page is linked to from the following overview topics: RTTI and GetInterface(), Handling Requests for Interfaces, Plug-in Architecture.

---

Search for all occurrences

---

Detailed Description

See also:

Class InterfaceServer, Class InterfaceNotifyCallback, Class FPInterface, Function Publishing System.

Description:

This class is available in release 4.0 and later only.

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.

#include <baseinterface.h>

Inherits InterfaceServer.

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

List of all members.

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

enum LifetimeType

Search for all occurrences

Enumerator:

noRelease	Search for all occurrences
immediateRelease	Search for all occurrences
wantsRelease	Search for all occurrences
serverControlled	Search for all occurrences

{ noRelease, immediateRelease, wantsRelease, serverControlled }; 

---

Constructor & Destructor Documentation

virtual UtilExport ~BaseInterface

(

)

[virtual]

Destructor.

---

Member Function Documentation

UtilExport BaseInterface* GetInterface

(

Interface_ID

id

)

[virtual]

Search for all occurrences

Remarks:

Returns a pointer to the interface whose ID is specified.

Parameters:

Interface_ID id

The ID of the interface to return.

Default Implementation:

{ return NULL; }

Reimplemented from InterfaceServer.

Reimplemented in IActionOptions, ActionItem, IActionItemStandin, ActionItemStandin, ActionTable, FPInterface, FPInterfaceDesc, FPMixinInterface, IIKGoal, IHIIKGoal, ISplineIKGoal, IMaterialBrowserEntryInfo, IMaterialViewportShading, INode, IParamBlock2PostLoadInfo, INodeEventCallback, ITreeView, SimpleManipulator, ITrackBar, Interface, MeshSelectionConverter, MeshNormalSpec, MNNormalSpec, Effect8, BezierShapeInterface_Ex41, AssetUser, IObjectDisplay, MSPluginSpecialFX< Effect8 >, and MSSpecialFXXtnd< Effect, MSPluginEffect >.

virtual UtilExport Interface_ID GetID

(

)

[virtual]

Search for all occurrences

Remarks:

This method returns the unique interface ID.

Reimplemented in IActionOptions, ActionItem, IActionItemStandin, ActionTable, IActionManager10, IColorSwatchRenamer, ID3D9GraphicsWindow, IDaylightControlledLightSystem, IDaylightSystem2, ID3D10HardwareRenderer, ID3D10GraphicsWindow, ID3D10ShaderResource, IDX8PixelShader, IDX8VertexShader, IDX9PixelShader, IDX9VertexShader, IEmissionColor, IFaceDataMgr, FPInterfaceDesc, FPMixinInterface, 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, IDXDataBridge, IDX9DataBridge, LightscapeLight::AreaLightCustAttrib, MeshSelectionConverter, MeshNormalSpec, IMNTempData10, IMNMeshUtilities8, IMNMeshUtilities10, IMNMeshUtilities13, MNNormalSpec, IXTCAccess, ITimeBasedConverter, IRadiosityEffectExtension, IRadiosityRenderParameters, IRendererRequirements, IRenderElementRequirements, IEffectFile, BezierShapeInterface_Ex41, IToneOperatorExtension, AssetUser, IObjectDisplay, IParameterTranslator, IShaderManager, ITextureDisplay, IMRPhysicalSkyEnvironmentMap, IMRPhysicalSkyInterface, IMRPhysicalSkyInterface2, IMRPhysicalSunLight, imrShader, imrShaderTranslation, imrMaterialPhenomenonTranslation, imrGeomShaderTranslation, IMrSkyPortalLight, IXRefAtmospheric, IXRefCtrl, IXRefItem, IXRefMaterial, IXRefObject8, IObjXRefRecord, and IXRefProxy.

virtual LifetimeType LifetimeControl

(

)

[inline, virtual]

Search for all occurrences

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 ID3D9GraphicsWindow, IEmissionColor, FPInterfaceDesc, FPMixinInterface, IHardwareMaterial, IHardwareMesh, IHardwareMNMesh, IHardwareRenderer, ID3DHWMeshCacheManager, IHardwareShader, IIKGoal, INodeValidity, IDXDataBridge, IDX9DataBridge, Plane, GizmoShape, IXTCAccess, XMLAnimTreeEntry, XMLAnimTreeEntryList, NodeAndAnims, and AssetUser.

{ return noRelease; }

virtual bool RegisterNotifyCallback

(

InterfaceNotifyCallback *

incb

)

[inline, virtual]

Search for all occurrences

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]

Search for all occurrences

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]

Search for all occurrences

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]

Search for all occurrences

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]

Search for all occurrences

Remarks:

This method can be used as a direct interface delete request.

Default Implementation:

{ }

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

{ };

virtual BaseInterface* CloneInterface

(

void *

remapDir = NULL

)

[inline, virtual]

Search for all occurrences

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; }