Interface_ID Class Reference

#include <maxtypes.h>

Inheritance diagram for Interface_ID:

Public Member Functions
constexpr	Interface_ID ()=default
constexpr	Interface_ID (const Interface_ID &iid)=default
constexpr	Interface_ID (ulong aa, ulong bb)
constexpr ulong	PartA () const
constexpr ulong	PartB () const
ulong	PartA ()
ulong	PartB ()
constexpr void	SetPartA (ulong aa)
constexpr void	SetPartB (ulong bb)
constexpr bool	operator== (const Interface_ID &iid) const
constexpr bool	operator!= (const Interface_ID &iid) const
constexpr Interface_ID &	operator= (const Interface_ID &iid)
constexpr bool	operator< (const Interface_ID &rhs) const

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

Detailed Description

See also

Class FPInterface, Function Publishing.

Description:

This class is the interface ID for the Function Publishing System of 3ds Max. This class is structurally very similar to a Class_ID, containing two randomly-chosen longwords to provide a unique global ID. The various constructors assign a value to each of these. There are also methods to assign and retrieve the individual parts and operators to check for equality or inequality.

All the methods of this class are implemented by the system.

Constructor & Destructor Documentation

Interface_ID() [1/3]

constexpr Interface_ID ( )

constexprdefault

Remarks

Constructor. The two parts of the ID are initialized to 0xffffffff.

Interface_ID() [2/3]

constexpr Interface_ID ( const Interface_ID &  iid )

constexprdefault

Remarks

Constructor. The two parts of the ID are initialized from the corresponding parts of the Interface_ID passed.

Parameters:

const Interface_ID& iid

The ID whose parts are used to initialize this ID.

Interface_ID() [3/3]

constexpr Interface_ID ( ulong  aa, ulong  bb  )

inlineconstexpr

Remarks

Constructor. The two parts of the ID are initialized from the from the parts passed.

Parameters:

ulong aa

Passed to initialize the first part of the ID.

ulong bb

Passed to initialize the second part of the ID.

: a(aa), b(bb) {}

Member Function Documentation

PartA() [1/2]

constexpr ulong PartA ( ) const

inlineconstexpr

Remarks

Returns the first part of the ID.

{ return a; }

PartB() [1/2]

constexpr ulong PartB ( ) const

inlineconstexpr

Remarks

Returns the second part of the ID.

{ return b; }

PartA() [2/2]

ulong PartA ( )

inline

{ return a; }

PartB() [2/2]

ulong PartB ( )

inline

{ return b; }

SetPartA()

constexpr void SetPartA ( ulong  aa )

inlineconstexpr

Remarks

Sets the first part of the ID.

Parameters:

ulong aa

Passed to set the first part.

{ a = aa; }

SetPartB()

constexpr void SetPartB ( ulong  bb )

inlineconstexpr

Remarks

Sets the second part of the ID.

Parameters:

ulong bb

Passed to set the second part.

{ b = bb; }

operator==()

constexpr bool operator== ( const Interface_ID &  iid ) const

inlineconstexpr

Remarks

Equality operator. Returns nonzero if the two parts of the ID are equal to the ID passed; otherwise zero.

Parameters:

const Interface_ID& iid

The ID to check.

{ return (a == iid.a) && (b == iid.b); }

operator!=()

constexpr bool operator!= ( const Interface_ID &  iid ) const

inlineconstexpr

Remarks

Inequality operator. Returns nonzero if either of the parts of the ID are NOT equal to the ID passed; otherwise zero.

Parameters:

const Interface_ID& iid

The ID to check.

{ return !operator==(iid); }

operator=()

constexpr Interface_ID& operator= ( const Interface_ID &  iid )

inlineconstexpr

Remarks

Assignment operator.

Parameters:

const Interface_ID& iid

The ID to assign from.

{ a = iid.a; b = iid.b; return *this; };

operator<()

constexpr bool operator< ( const Interface_ID &  rhs ) const

inlineconstexpr

{ return a < rhs.a || (a == rhs.a && b < rhs.b); }