IObjXRefManager Class Reference

#include <iXrefObjMgr.h>

Class Description

Legacy interface for managing object xrefs.

Remarks

This interface should be considered obsolete. Please use IObjXRefManager8 instead. Note that this interface does not provide full support for multiple object xref records/links created from the same source file.

See also

IObjXRefManager8

<h2>Note:</h2> In 3ds Max 8 this class was replaced with

class IObjXRefManager8. It is still documented for backwards compatibility.

Class IXRefObject, Class FPStaticInterface, Reference Messages

Description:

This class represents the interface to the Object XRef Manager. You can obtain a pointer to the Object XRef Manager interface using; IObjXRefManager* GetObjXRefManager(). This macro will return

(IObjXRefManager*)GetCOREInterface(OBJXREFMANAGER_INTERFACE).

All methods of this class are Implemented by the System.

Inheritance diagram for IObjXRefManager:

Public Types
enum	{   fnIdAddXRefObject, fnIdGetNumXRefObjects, fnIdGetXRefObject, fnIdGetNumFiles,   fnIdGetFileName, fnIdReloadFile, fnIdIsFileUnresolved, fnIdIsFileDisabled,   fnIdGetAllXRefObjects }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions
virtual IXRefObject *	AddXRefObject (const MaxSDK::AssetManagement::AssetUser &asset, const MCHAR *obname, int xFlags=0)=0
virtual int	GetNumXRefObjects (const MaxSDK::AssetManagement::AssetUser &asset)=0
virtual IXRefObject *	GetXRefObject (const MaxSDK::AssetManagement::AssetUser &asset, int i)=0
virtual int	GetNumFiles ()=0
virtual const MaxSDK::AssetManagement::AssetUser &	GetFile (int fidx)=0
virtual BOOL	ReloadFile (const MaxSDK::AssetManagement::AssetUser &asset)=0
virtual BOOL	IsFileUnresolved (const MaxSDK::AssetManagement::AssetUser &asset)=0
virtual BOOL	IsFileDisabled (const MaxSDK::AssetManagement::AssetUser &asset)=0
virtual void	GetAllXRefObjects (Tab< IXRefObject * > &objs)=0
Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()
CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...)
CoreExport	~FPInterfaceDesc ()
virtual void	Init ()
LifetimeType	LifetimeControl ()
virtual BaseInterface *	GetInterface (Interface_ID id)
CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...)
CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor. More...
CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor. More...
CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor. More...
CoreExport void	SetClassDesc (ClassDesc *i_cd)
CoreExport va_list	check_fn (va_list ap, int id)
CoreExport va_list	scan_fn (va_list ap, int id, int index)
CoreExport va_list	check_prop (va_list ap, int id)
CoreExport va_list	scan_prop (va_list ap, int id, int index)
CoreExport va_list	check_enum (va_list ap, EnumID id)
CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)
FPInterfaceDesc *	GetDesc ()
Interface_ID	GetID ()
CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)
ActionTable *	GetActionTable ()
CoreExport void	EnableActions (BOOL onOff)
virtual CoreExport HINSTANCE	HInstance ()
virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)
Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...
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)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID
MSTR	internal_name
StringResID	description
ClassDesc *	cd
USHORT	flags
Tab< FPFunctionDef * >	functions
Tab< FPPropDef * >	props
Tab< FPEnum * >	enumerations
MSPluginClass *	pc
Rollout *	rollout
ActionTable *	action_table
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Member Enumeration Documentation

anonymous enum

Enumerator
fnIdAddXRefObject
fnIdGetNumXRefObjects
fnIdGetXRefObject
fnIdGetNumFiles
fnIdGetFileName
fnIdReloadFile
fnIdIsFileUnresolved
fnIdIsFileDisabled
fnIdGetAllXRefObjects

         { 
        fnIdAddXRefObject,
        fnIdGetNumXRefObjects,
        fnIdGetXRefObject,
        fnIdGetNumFiles,
        fnIdGetFileName,
        fnIdReloadFile,
        fnIdIsFileUnresolved,
        fnIdIsFileDisabled,
        fnIdGetAllXRefObjects,
    };

Member Function Documentation

virtual IXRefObject* AddXRefObject ( const MaxSDK::AssetManagement::AssetUser &  asset, const MCHAR *  obname, int  xFlags = 0  )

pure virtual

Remarks

This method allows you to add an XRef object to the scene by providing the file and object name.

Parameters:

const MaxSDK::AssetManagement::AssetUser &asset

The file asset of the scene containing the object to add.

MCHAR *obname

The name of the object in the scene.

Returns

A pointer to the newly added xref object, or NULL in case the file or name were invalid.

virtual int GetNumXRefObjects ( const MaxSDK::AssetManagement::AssetUser &  asset )

pure virtual

Remarks

This method returns the number if IXRefObjects that reference a certain file name. It is possible to iterate over the IXRefObjects of a certain file by using GetXRefObject.

Parameters:

const MaxSDK::AssetManagement::AssetUser &asset

The file name you wish to check references for.

virtual IXRefObject* GetXRefObject ( const MaxSDK::AssetManagement::AssetUser &  asset, int  i  )

pure virtual

Remarks

This method returns a pointer to the I-th IXRefObject that references a certain file.

Parameters:

const MaxSDK::AssetManagement::AssetUser &asset

The file you wish to check references for.

int i

The index of the object.

virtual int GetNumFiles ( )

pure virtual

Remarks

This method will return the number of files that contain object XRef's.

virtual const MaxSDK::AssetManagement::AssetUser& GetFile ( int  fidx )

pure virtual

Remarks

This method returns the file asset of the file that contains the specified object XRef.

Parameters:

int fidx

The index of the object XRef for which to get the file.

virtual BOOL ReloadFile ( const MaxSDK::AssetManagement::AssetUser &  asset )

pure virtual

Remarks

This method will reload the file represented by the specified asset.

Parameters:

const MaxSDK::AssetManagement::AssetUser &asset

The file name to reload.

Returns

TRUE if the reload was successful, otherwise FALSE.

virtual BOOL IsFileUnresolved ( const MaxSDK::AssetManagement::AssetUser &  asset )

pure virtual

Remarks

This method returns whether or not the specified file asset is unresolved.

Parameters:

const MaxSDK::AssetManagement::AssetUser &asset

The file name to check.

Returns

TRUE if the file is unresolved, otherwise FALSE.

virtual BOOL IsFileDisabled ( const MaxSDK::AssetManagement::AssetUser &  asset )

pure virtual

Remarks

This method returns whether or not the specified file name is disabled.

Parameters:

const MaxSDK::AssetManagement::AssetUser &asset

The file name to check.

Returns

TRUE if the file is disabled, otherwise FALSE.

virtual void GetAllXRefObjects ( Tab< IXRefObject * > &  objs )

pure virtual

Remarks

This method fills the IXRefObject table with all XrefObjects that are in the scene.

Parameters:

Tab<IXRefObject*> &objs

The table in which to receive all IXRefObject's in the scene.