Interface_ID Class Reference

This reference page is linked to from the following overview topics: Porting Object Plug-ins to Nitrous, Porting Advanced Material and Texture Map Plug-ins to Nitrous, Interface Querying, Handling Requests for Interfaces, Interface Querying, The Function Publishing API, Mesh Example, Action Interfaces.

---

Search for all occurrences

---

Detailed Description

See also:

Class FPInterface, Function Publishing System.

Description:

This class is available in release 4.0 and later only.

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.

#include <maxtypes.h>

Inheritance diagram for Interface_ID:

List of all members.

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

---

Constructor & Destructor Documentation

Interface_ID

(

)

[inline]

Remarks:

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

{ a = b = 0xffffffff; }

Interface_ID

(

const Interface_ID &

iid

)

[inline]

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.

{ a = iid.a; b = iid.b; }

Interface_ID	(	ulong	aa,
		ulong	bb
	)		[inline]

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

ULONG PartA

(

)

[inline]

Search for all occurrences

Remarks:

Returns the first part of the ID.

{ return a; }

ULONG PartB

(

)

[inline]

Search for all occurrences

Remarks:

Returns the second part of the ID.

{ return b; }

void SetPartA

(

ulong

aa

)

[inline]

Search for all occurrences

Remarks:

Sets the first part of the ID.

Parameters:

ulong aa

Passed to set the first part.

{ a = aa; }

void SetPartB

(

ulong

bb

)

[inline]

Search for all occurrences

Remarks:

Sets the second part of the ID.

Parameters:

ulong bb

Passed to set the second part.

{ b = bb; }

int operator==

(

const Interface_ID &

iid

)

const [inline]

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); }

int operator!=

(

const Interface_ID &

iid

)

const [inline]

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 (a!=iid.a||b!=iid.b); }

Interface_ID& operator=

(

const Interface_ID &

iid

)

[inline]

Remarks:

Assignment operator.

Parameters:

const Interface_ID& iid

The ID to assign from.

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

bool operator<

(

const Interface_ID &

rhs

)

const [inline]

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

        return false;
    }