IObjXRefManager Class Reference
 
 
 
IObjXRefManager Class Reference

#include <iXrefObjMgr.h>

Inheritance diagram for IObjXRefManager:
FPStaticInterface FPInterfaceDesc FPInterface BaseInterface InterfaceServer MaxHeapOperators

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

Note:

In 3ds Max 8 this class was replaced with class IObjXRefManager8. It is still documented for backwards compatibility.

See also:
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.

Public Types

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

Public Member Functions

virtual IXRefObject AddXRefObject (const MaxSDK::AssetManagement::AssetUser &asset, const MCHAR *obname, int xFlags=0)=0
virtual IXRefObject AddXRefObject (const MaxSDK::AssetManagement::AssetUser &asset, MCHAR *obname, int xFlags) sealed
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

Member Enumeration Documentation


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 IXRefObject* AddXRefObject ( const MaxSDK::AssetManagement::AssetUser asset,
MCHAR *  obname,
int  xFlags 
) [inline, sealed, virtual]
Deprecated:
Deprecated method in terms of implementation as of 3ds Max 2013 - re-implement with const MCHAR* method signature
                                                                                                                          { 
                return AddXRefObject(asset, const_cast<const MCHAR*>(obname), xFlags); }
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.