This interface extends IObjXRefManager8 interface. More...

#include <iXRefObjMgr8.h>

Inheritance diagram for IObjXRefManager18:

Public Types
enum	{ kfpGetEnableUseLocalProxySettingsForXRefObj = 0x100 , kfpSetEnableUseLocalProxySettingsForXRefObj , kfpGetDuplicateMatchingLayers , kfpSetDuplicateMatchingLayers , kfpGetTracksStatus , kfpSetTracksStatus }

enum	FPEnums { kfpTracksStatus }

Public Types inherited from IObjXRefManager8
enum	{ kfpRecordCount , kfpGetRecord , kfpFindRecord , kfpRemoveRecordFromScene , kfpMergeRecordIntoScene , kfpSetRecordSrcFile , kfpUpdateAllRecords , kfpSetXRefItemSrcName , kfpSetProxyItemSrcName , kfpSetXRefItemSrcFile , kfpSetProxyItemSrcFile , kfpRemoveXRefsFromScene , kfpMergeXRefsIntoScene , kfpAddXRefItemsToXRefRecord , kfpAddXRefItemsFromFile , kfpCanCombineRecords , kfpCombineRecords , kfpApplyXRefMaterialsToXRefObjects , kfpGetDupObjNameAction , kfpSetDupObjNameAction , kfpGetDupMtlNameAction , kfpSetDupMtlNameAction , kfpIsNodeXRefed , kfpApplyXRefControllersToXRefObjects , kfpResetXRefControllersPRSOffset , kfpCanResetXRefControllersPRSOffset , kfpGetMergeTransforms , kfpSetMergeTransforms , kfpGetMergeMaterials , kfpSetMergeMaterials , kfpGetMergeManipulators , kfpSetMergeManipulators , kfpGetMergeModifiers , kfpSetMergeModifiers , kfpGetIncludeAll , kfpSetIncludeAll , kfpGetAutoUpdate , kfpSetAutoUpdate }
	Function IDs used by function publishing. More...

enum	FPEnums { kfpXrefOptions , kfpDupNodeNameActions , kfpDupMaterialNameActions , kfpXrefModifierOptions }
	IDs of enumeration types used by function published methods. More...

Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions
virtual bool	IsEnableUseLocalProxySettingsForXRefObj () const =0
	get the status of EnableUseLocalProxySettings ForXRefObj More...

virtual void	SetEnableUseLocalProxySettingsForXRefObj (bool bEnableUseLocalProxySettings)=0
	set the status of EnableUseLocalProxySettings More...

virtual int	GetTracksStatus () const =0
	gets the status of object's track. More...

virtual void	SetTracksStatus (int status)=0
	sets the status of object's track. More...

virtual void	SetDuplicateMatchingLayers (bool in_duplicate)=0
	Sets whether to duplicate matching Layers without an identical parent hierarchy. More...

virtual bool	GetDuplicateMatchingLayers () const =0
	Returns the option of whether to duplicate matching Layers without an identical parent hierarchy. More...

	PROP_FNS (kfpGetEnableUseLocalProxySettingsForXRefObj, IsEnableUseLocalProxySettingsForXRefObj, kfpSetEnableUseLocalProxySettingsForXRefObj, SetEnableUseLocalProxySettingsForXRefObj, TYPE_bool)

	PROP_FNS (kfpGetDuplicateMatchingLayers, GetDuplicateMatchingLayers, kfpSetDuplicateMatchingLayers, SetDuplicateMatchingLayers, TYPE_bool)

	PROP_FNS (kfpGetTracksStatus, GetTracksStatus, kfpSetTracksStatus, SetTracksStatus, TYPE_ENUM)

Public Member Functions inherited from IObjXRefManager8
	RO_PROP_FN (kfpRecordCount, RecordCount, TYPE_DWORD)

	PROP_FNS (kfpGetDupObjNameAction, GetDupObjNameAction, kfpSetDupObjNameAction, SetDupObjNameAction, TYPE_ENUM)

	PROP_FNS (kfpGetDupMtlNameAction, GetDupMtlNameAction, kfpSetDupMtlNameAction, SetDupMtlNameAction, TYPE_ENUM)

	FN_1 (kfpGetRecord, TYPE_INTERFACE, GetRecord, TYPE_INDEX)

	FN_1 (kfpFindRecord, TYPE_INTERFACE, FindRecord, TYPE_DWORD)

	FN_1 (kfpRemoveRecordFromScene, TYPE_bool, FPRemoveRecordFromScene, TYPE_INTERFACE)

	FN_1 (kfpMergeRecordIntoScene, TYPE_bool, FPMergeRecordIntoScene, TYPE_INTERFACE)

	FN_2 (kfpSetRecordSrcFile, TYPE_bool, FPSetRecordSrcFile, TYPE_INTERFACE, TYPE_FILENAME)

	FN_0 (kfpUpdateAllRecords, TYPE_bool, UpdateAllRecords)

	FN_2 (kfpSetXRefItemSrcName, TYPE_bool, SetXRefItemSrcName, TYPE_REFTARG_BR, TYPE_STRING)

	FN_2 (kfpSetProxyItemSrcName, TYPE_bool, SetProxyItemSrcName, TYPE_REFTARG_BR, TYPE_STRING)

	FN_2 (kfpSetXRefItemSrcFile, TYPE_bool, FPSetXRefItemSrcFile, TYPE_REFTARG_BR, TYPE_FILENAME)

	FN_2 (kfpSetProxyItemSrcFile, TYPE_bool, FPSetProxyItemSrcFile, TYPE_REFTARG_BR, TYPE_FILENAME)

	FN_1 (kfpRemoveXRefsFromScene, TYPE_bool, RemoveXRefItemsFromScene, TYPE_REFTARG_TAB_BR)

	FN_1 (kfpMergeXRefsIntoScene, TYPE_bool, MergeXRefItemsIntoScene, TYPE_REFTARG_TAB_BR)

	FN_3 (kfpAddXRefItemsToXRefRecord, TYPE_bool, FPAddXRefItemsToXRefRecord, TYPE_INTERFACE, TYPE_bool, TYPE_STRING_TAB)

	FN_4 (kfpAddXRefItemsFromFile, TYPE_INTERFACE, FPAddXRefItemsFromFile, TYPE_FILENAME, TYPE_bool, TYPE_STRING_TAB, TYPE_ENUM_TAB_BR)

	FN_2 (kfpCanCombineRecords, TYPE_bool, FPCanCombineRecords, TYPE_INTERFACE, TYPE_INTERFACE)

	FN_1 (kfpCombineRecords, TYPE_INTERFACE, FPCombineRecords, TYPE_INTERFACE_TAB_BR)

	VFN_1 (kfpApplyXRefMaterialsToXRefObjects, ApplyXRefMaterialsToXRefObjects, TYPE_REFTARG_TAB_BR)

	FN_1 (kfpIsNodeXRefed, TYPE_INTERFACE, FPIsNodeXRefed, TYPE_INODE)

	VFN_1 (kfpApplyXRefControllersToXRefObjects, ApplyXRefControllersToXRefObjects, TYPE_REFTARG_TAB_BR)

	FN_1 (kfpResetXRefControllersPRSOffset, TYPE_bool, ResetXRefControllersPRSOffset, TYPE_REFTARG_TAB_BR)

	FN_1 (kfpCanResetXRefControllersPRSOffset, TYPE_bool, CanResetXRefControllersPRSOffset, TYPE_REFTARG_BR)

	PROP_FNS (kfpGetMergeTransforms, GetMergeTransforms, kfpSetMergeTransforms, SetMergeTransforms, TYPE_bool)

	PROP_FNS (kfpGetMergeMaterials, GetMergeMaterials, kfpSetMergeMaterials, SetMergeMaterials, TYPE_bool)

	PROP_FNS (kfpGetMergeManipulators, GetMergeManipulators, kfpSetMergeManipulators, SetMergeManipulators, TYPE_bool)

	PROP_FNS (kfpGetMergeModifiers, GetMergeModifiers, kfpSetMergeModifiers, SetMergeModifiers, TYPE_ENUM)

	PROP_FNS (kfpGetIncludeAll, GetIncludeAll, kfpSetIncludeAll, SetIncludeAll, TYPE_bool)

	PROP_FNS (kfpGetAutoUpdate, GetAutoUpdate, kfpSetAutoUpdate, SetAutoUpdate, TYPE_bool)

virtual unsigned int	RecordCount () const =0

virtual IObjXRefRecord *	GetRecord (unsigned int i) const =0
	Retrieves the i-th xref record. More...

virtual IObjXRefRecord *	FindRecord (XRefRecordHandle xrefRecHandle) const =0
	Retrieves an xref record based on its unique handle. More...

virtual bool	CanCombineRecords (const IObjXRefRecord &firstRecord, const IObjXRefRecord &secondRecord) const =0
	Determines whether two xref records can be combined. More...

virtual IObjXRefRecord *	CombineRecords (Tab< IObjXRefRecord * > &xrefRecords)=0
	Combines several xref records into one single record. More...

virtual bool	RemoveRecordFromScene (const IObjXRefRecord &xrefRecord)=0
	Removes an xref record from the scene. More...

virtual bool	MergeRecordIntoScene (const IObjXRefRecord &xrefRecord)=0
	Merges an xref record into the scene. More...

virtual bool	SetRecordSrcFile (IObjXRefRecord &xrefRecord, const MaxSDK::AssetManagement::AssetUser &srcFileName)=0
	Sets a new file path and name for the specified xref record. More...

virtual bool	UpdateAllRecords ()=0
	Updates all xref records. More...

virtual IObjXRefRecord *	AddXRefItemsFromFile (const MaxSDK::AssetManagement::AssetUser &srcFileName, bool promptObjNames, const Tab< const MCHAR * > *objNames, unsigned int xrefOptions)=0
	This method allows for xrefing scene entities from the specified source file. More...

virtual bool	AddXRefItemsToXRefRecord (IObjXRefRecord &xrefRecord, bool promptObjNames, const Tab< const MCHAR * > *objNames)=0
	Adds new xref items to an existent xref record from the record's source file. More...

virtual bool	RemoveXRefItemsFromScene (const Tab< ReferenceTarget * > &xrefItems)=0
	Removes the specified xref items from the scene. More...

virtual bool	MergeXRefItemsIntoScene (const Tab< ReferenceTarget * > &xrefItems)=0
	Merges the specified xref items into the scene. More...

virtual void	ApplyXRefMaterialsToXRefObjects (const Tab< ReferenceTarget * > &objectXRefItems)=0
	Applies or re-applies an xref material to a list of xref objects and reset its overide material. More...

virtual void	ApplyXRefControllersToXRefObjects (const Tab< ReferenceTarget * > &objectXRefItems)=0
	Applies or re-applies an xref controller to a list of xref objects. More...

virtual bool	CanResetXRefControllersPRSOffset (ReferenceTarget &inXRefItem) const =0
	Determines whether an Item can have its Offset matrix being reset. More...

virtual bool	ResetXRefControllersPRSOffset (const Tab< ReferenceTarget * > &inXRefItems)=0
	Set XRef controllers' offset matrix back to identity, and if any, set the corresponding source controller's transformation matrix accordingly. More...

virtual bool	SetXRefItemSrcName (ReferenceTarget &xrefItem, const MCHAR *srcItemName)=0
	Sets a new scene entity for the specified xref item. More...

virtual bool	SetProxyItemSrcName (ReferenceTarget &xrefProxy, const MCHAR *proxyName)=0
	Sets a new scene entity for the specified xref proxy. More...

virtual bool	SetXRefItemSrcFile (ReferenceTarget &xrefItem, const MaxSDK::AssetManagement::AssetUser &srcAsset)=0
	Sets a new file for the specified xref item. More...

virtual bool	SetProxyItemSrcFile (ReferenceTarget &xrefProxy, const MaxSDK::AssetManagement::AssetUser &proxyAsset)=0
	Sets a new file for the specified xref proxy. More...

virtual unsigned int	GetDupObjNameAction () const =0

virtual void	SetDupObjNameAction (unsigned int action)=0
	Sets the action to be taken during xrefing when a source object has a name that is already used by a main scene object. More...

virtual unsigned int	GetDupMtlNameAction () const =0
	Gets the action taken during xrefing when a source material has a name that is already used by a main scene material. More...

virtual void	SetDupMtlNameAction (unsigned int action)=0
	Gets the action taken during xrefing when a source material has a name that is already used by a main scene material. More...

virtual IXRefObject8 *	IsNodeXRefed (INode &node) const =0
	Determines if a node is xrefed. More...

virtual void	SetMergeTransforms (bool in_merge)=0
	Merged controllers (as opposed to xref'd controllers) will be accessible and modifiable in the main scene. More...

virtual bool	GetMergeTransforms () const =0
	Returns the current setting of whether the transform controllers of nodes are merged when xrefing objects. More...

virtual void	SetMergeMaterials (bool in_merge)=0
	Sets the option of merging the materials of nodes when xrefing objects. More...

virtual bool	GetMergeMaterials () const =0
	Returns the option of merging the material of nodes when xrefing objects. More...

virtual void	SetMergeManipulators (bool in_merge)=0
	Sets the option of merging the manipulators of nodes when xrefing objects. More...

virtual bool	GetMergeManipulators () const =0
	Returns the option of merging manipulators when xrefing objects. More...

virtual void	SetMergeModifiers (int in_merge)=0
	Sets the option of merging the modifiers of nodes when xrefing objects. More...

virtual int	GetMergeModifiers () const =0
	Sets the handling of modifiers of nodes when xrefing objects. More...

virtual void	SetIncludeAll (bool in_include)=0
	Sets whether all nodes of a file will be added to a new xref record. More...

virtual bool	GetIncludeAll () const =0
	Returns the option of whether all nodes of a file will be added to a new xref record. More...

virtual void	SetAutoUpdate (bool in_autoUpdate)=0
	Sets whether the content of the xref record will update on source file update. More...

virtual bool	GetAutoUpdate () const =0
	Returns the option of whether the content of the xref record will update on source file update. More...

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=nullptr)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Static Public Member Functions
static IObjXRefManager18 *	GetInstance ()

Static Public Member Functions inherited from IObjXRefManager8
static IObjXRefManager8 *	GetInstance ()
	Retrieves a pointer to the IObjXRefManager8 interface. More...

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

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Additional Inherited Members
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)

Detailed Description

This interface extends IObjXRefManager8 interface.

This interface is implemented by the system (3ds max). To obtain a pointer to the object xref manager, call IObjXRefManager18::GetInstace()

See also: IObjXRefManager8

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
kfpGetEnableUseLocalProxySettingsForXRefObj
kfpSetEnableUseLocalProxySettingsForXRefObj
kfpGetDuplicateMatchingLayers
kfpSetDuplicateMatchingLayers
kfpGetTracksStatus
kfpSetTracksStatus

          { 
         kfpGetEnableUseLocalProxySettingsForXRefObj = 0x100, // to avoid duplication
         kfpSetEnableUseLocalProxySettingsForXRefObj,
         kfpGetDuplicateMatchingLayers,
         kfpSetDuplicateMatchingLayers,
         kfpGetTracksStatus,
         kfpSetTracksStatus,
     };

◆ FPEnums

enum FPEnums

Enumerator
kfpTracksStatus

     {
         kfpTracksStatus
     };

Member Function Documentation

◆ IsEnableUseLocalProxySettingsForXRefObj()

virtual bool IsEnableUseLocalProxySettingsForXRefObj ( ) const

pure virtual

get the status of EnableUseLocalProxySettings ForXRefObj

EnableUseLocalProxySettings means while creating XRef objects, whether we turn its proxy's Enable/Use Local setting on by default.

Returns: bool - if EnableUseLocalProxySettings is enabled or not.

◆ SetEnableUseLocalProxySettingsForXRefObj()

virtual void SetEnableUseLocalProxySettingsForXRefObj ( bool bEnableUseLocalProxySettings )

pure virtual

set the status of EnableUseLocalProxySettings

EnableUseLocalProxySettings means while creating XRef objects, whether we turn its proxy's Enable/Use Local setting on by default.

Parameters

[in] bEnableUseLocalProxySettings - true to enable , false otherwise.

◆ GetTracksStatus()

virtual int GetTracksStatus ( ) const

pure virtual

gets the status of object's track.

Object's track may inherit the source or become local for editing.

Returns: int - if XREF_TRACKS_XREF, it means track will inherit the source. if XREF_TRACKS_LOCAL, it means track will be local for editing.

◆ SetTracksStatus()

virtual void SetTracksStatus ( int status )

pure virtual

sets the status of object's track.

Object's track may inherit the source or become local for editing.

Parameters

[in]

status

- indicate the object's track status.
Possible values are:

XREF_TRACKS_XREF: track will inherit the source.
XREF_TRACKS_LOCAL: track will be local for editing.

◆ SetDuplicateMatchingLayers()

virtual void SetDuplicateMatchingLayers ( bool in_duplicate )

pure virtual

Sets whether to duplicate matching Layers without an identical parent hierarchy.

Parameters

[in] in_duplicate - to duplicate matching Layers without an identical parent hierarchy.

◆ GetDuplicateMatchingLayers()

virtual bool GetDuplicateMatchingLayers ( ) const

pure virtual

Returns the option of whether to duplicate matching Layers without an identical parent hierarchy.

◆ GetInstance()

static IObjXRefManager18* GetInstance ( )

inlinestatic

     {
         return static_cast<IObjXRefManager18*>(GetCOREInterface(IID_OBJ_XREF_MGR8)); 
     }

◆ PROP_FNS() [1/3]

PROP_FNS	(	kfpGetEnableUseLocalProxySettingsForXRefObj	,
		IsEnableUseLocalProxySettingsForXRefObj	,
		kfpSetEnableUseLocalProxySettingsForXRefObj	,
		SetEnableUseLocalProxySettingsForXRefObj	,
		TYPE_bool
	)

◆ PROP_FNS() [2/3]

PROP_FNS	(	kfpGetDuplicateMatchingLayers	,
		GetDuplicateMatchingLayers	,
		kfpSetDuplicateMatchingLayers	,
		SetDuplicateMatchingLayers	,
		TYPE_bool
	)

◆ PROP_FNS() [3/3]

PROP_FNS	(	kfpGetTracksStatus	,
		GetTracksStatus	,
		kfpSetTracksStatus	,
		SetTracksStatus	,
		TYPE_ENUM
	)

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ FPEnums

Member Function Documentation

◆ IsEnableUseLocalProxySettingsForXRefObj()

◆ SetEnableUseLocalProxySettingsForXRefObj()

◆ GetTracksStatus()

◆ SetTracksStatus()

◆ SetDuplicateMatchingLayers()

◆ GetDuplicateMatchingLayers()

◆ GetInstance()

◆ PROP_FNS() [1/3]

◆ PROP_FNS() [2/3]

◆ PROP_FNS() [3/3]