This interface extends IObjXRefRecord interface. More...

#include <iXRefObjRecord.h>

Inheritance diagram for IObjXRefRecord16:

Public Member Functions
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...

virtual unsigned int	GetRecordID () const =0
	Retrieves the record's "unique" identifier. More...

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

	RO_PROP_FN (kfpGetRecordId, GetRecordID, TYPE_DWORD)

Public Member Functions inherited from IObjXRefRecord
virtual Interface_ID	GetID ()

virtual FPInterfaceDesc *	GetDesc ()

	FN_1 (kfpItemCount, TYPE_DWORD, FPItemCount, TYPE_ENUM_TAB_BR)

	FN_2 (kfpGetItem, TYPE_REFTARG, FPGetItem, TYPE_INDEX, TYPE_ENUM)

	FN_2 (kfpGetItems, TYPE_DWORD, FPGetItems, TYPE_ENUM_TAB_BR, TYPE_REFTARG_TAB_BR)

	FN_1 (kfpGetChildRecords, TYPE_DWORD, FPGetChildRecords, TYPE_INTERFACE_TAB_BR)

	FN_1 (kfpGetParentRecords, TYPE_DWORD, FPGetParentRecords, TYPE_INTERFACE_TAB_BR)

	FN_1 (kfpGetRootRecords, TYPE_DWORD, FPGetRootRecords, TYPE_INTERFACE_TAB_BR)

	FN_0 (kfpCheckSrcFileChanged, TYPE_bool, CheckSrcFileChanged)

	FN_0 (kfpUpdate, TYPE_bool, Update)

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

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

	PROP_FNS (kfpGetEnabled, IsEnabled, kfpSetEnabled, SetEnable, TYPE_bool)

	PROP_FNS (kfpGetUpToDate, GetUpToDate, kfpSetUpToDate, SetUpToDate, TYPE_bool)

	RO_PROP_FN (kfpIsEmpty, IsEmpty, TYPE_bool)

	RO_PROP_FN (kfpIsUnresolved, IsUnresolved, TYPE_bool)

	PROP_FNS (kfpGetSrcFileName, FPGetSrcFileName, kfpSetSrcFileName, FPSetSrcFileName, TYPE_FILENAME)

	RO_PROP_FN (kfpGetHandle, GetHandle, TYPE_DWORD)

	RO_PROP_FN (kfpGetXRefOptions, FPGetXRefOptions, TYPE_ENUM_TAB_BV)

	RO_PROP_FN (kfpIsNested, IsNested, TYPE_bool)

virtual unsigned int	ItemCount (IXRefItem::XRefItemType itemType) const =0

virtual unsigned int	GetItems (IXRefItem::XRefItemType itemType, Tab< ReferenceTarget * > &xrefItems) const =0
	Retrieves all the xref items of the specified type. More...

virtual ReferenceTarget *	GetItem (unsigned int i, IXRefItem::XRefItemType itemType) const =0
	Retrieves the i-th xref item of the specified type. More...

virtual bool	IsEmpty () const =0
	Allows to verify whether this record contains any xref items. More...

virtual unsigned int	GetChildRecords (Tab< IObjXRefRecord * > &childRecords) const =0
	Retrieves all child xref records of this record. More...

virtual unsigned int	GetParentRecords (Tab< IObjXRefRecord * > &parentRecords) const =0
	Retrieves all parent xref records of this record. More...

virtual unsigned int	GetRootRecords (Tab< IObjXRefRecord * > &rootRecords) const =0
	Retrieves all root (top-level) xref records of this record. More...

virtual bool	IsNested () const =0
	Retrives whether this xref record has parent records or not. More...

virtual unsigned int	GetXRefOptions () const =0
	Retrives the options used to create this xref record. More...

virtual bool	IsIncludeAll () const =0
	Retrieves whether all scene entities are xrefed from this record's source file. More...

virtual void	SetIncludeAll (bool bEnable)=0
	Sets the xrefing of all scene entities from this record's source file. More...

virtual bool	IsEnabled () const =0
	Retrieves the enabled state of this xref record. More...

virtual void	SetEnable (bool bEnable)=0
	Sets the enabled state of this xref record. More...

virtual bool	IsAutoUpdate () const =0
	Retrieves whether auto-update is enabled for this xref record. More...

virtual void	SetAutoUpdate (bool bEnable)=0
	Sets the state of the auto-upate for this xref record. More...

virtual bool	GetUpToDate () const =0
	Allows to verify whether the xref record is up-to-date. More...

virtual void	SetUpToDate (bool bUpToDate)=0
	Allows to set an xref record as out-of-date. More...

virtual bool	CheckSrcFileChanged ()=0
	Verifies whether the source file of this xref record has changed since the record was last updated. More...

virtual bool	IsUnresolved () const =0
	Allows to verify whether the xref record is unresolved. More...

virtual const MaxSDK::AssetManagement::AssetUser &	GetSrcFile () const =0
	Retrieves the asset Id of the source file. More...

virtual const MSTR &	GetParentSrcFileName () const =0
	Returns the parent Xref record source file name. More...

virtual bool	Update ()=0
	The xref entities are reloaded according to the currently set options. More...

virtual XRefRecordHandle	GetHandle () const =0
	Retrieves the record's unique handle. More...

Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()

virtual LifetimeType	LifetimeControl ()

virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

CoreExport	~FPMixinInterface ()

virtual BaseInterface *	GetInterface (Interface_ID id)

virtual FPInterfaceDesc *	GetDescByID (Interface_ID 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)

virtual ActionTable *	GetActionTable ()

virtual void	EnableActions (BOOL onOff)

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

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

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Public Types inherited from IObjXRefRecord
enum	FPFuncIDs { kfpItemCount , kfpIsEmpty , kfpGetItem , kfpGetItems , kfpGetChildRecords , kfpGetParentRecords , kfpGetRootRecords , kfpIsNested , kfpGetIncludeAll , kfpSetIncludeAll , kfpGetAutoUpdate , kfpSetAutoUpdate , kfpGetEnabled , kfpSetEnabled , kfpGetUpToDate , kfpSetUpToDate , kfpCheckSrcFileChanged , kfpIsUnresolved , kfpGetSrcFileName , kfpSetSrcFileName , kfpGetSrcFileAssetId , kfpSetSrcFileAssetId , kfpUpdate , kfpGetRecordId , kfpGetHandle , kfpGetXRefOptions , kfpGetDuplicateMatchingLayers , kfpSetDuplicateMatchingLayers }

enum	FPEnums { kfpXRefItemTypes , kfpXRefItemTypesNoAll , kfpXrefOptions }

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

Static Public Member Functions inherited from IObjXRefRecord
static IObjXRefRecord *	GetInterface (InterfaceServer *is)
	Retrieves the IObjXRefRecord interface from an InterfaceServer. 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...

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)

FPMixinInterface &	operator= (const FPMixinInterface &rhs)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Detailed Description

This interface extends IObjXRefRecord interface.

See also: IObjXRefRecord

Member Function Documentation

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

◆ GetRecordID()

virtual unsigned int GetRecordID ( ) const

pure virtual

Retrieves the record's "unique" identifier.

◆ PROP_FNS()

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

◆ RO_PROP_FN()

RO_PROP_FN	(	kfpGetRecordId	,
		GetRecordID	,
		TYPE_DWORD
	)

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ SetDuplicateMatchingLayers()

◆ GetDuplicateMatchingLayers()

◆ GetRecordID()

◆ PROP_FNS()

◆ RO_PROP_FN()