SimpleWSMObject2 Class Reference

Search for all occurrences

#include <simpobj.h>

Inheritance diagram for SimpleWSMObject2:

List of all members.

Public Member Functions
	SimpleWSMObject2 ()
RefTargetHandle	GetReference (int i)
	Returns the 'i-th' reference.
Public Attributes
IParamBlock2 *	pblock2
Protected Member Functions
virtual void	SetReference (int i, RefTargetHandle rtarg)
	Stores a ReferenceTarget as its 'i-th' reference`.

---

Constructor & Destructor Documentation

SimpleWSMObject2

(

)

[inline]

{ pblock2 = NULL; }

---

Member Function Documentation

RefTargetHandle GetReference

(

int

i

)

[inline, virtual]

Search for all occurrences

Returns the 'i-th' reference.

The plugin implements this method to return its 'i-th' reference. The plug-in simply keeps track of its references using an integer index for each one. This method is normally called by the system.

Parameters:

i	- The index of the reference to retrieve. Valid values are from 0 to NumRefs()-1.

Returns:

The reference handle of the 'i-th' reference. Note that different calls to this method with the same 'i' value can result in different reference handles being retrieved, as the plugin changes the scene objects it references as its 'i-th' reference.

Reimplemented from SimpleWSMObject.

{return (RefTargetHandle)pblock;}

virtual void SetReference	(	int	i,
		RefTargetHandle	rtarg
	)		[inline, protected, virtual]

Search for all occurrences

Stores a ReferenceTarget as its 'i-th' reference`.

The plugin implements this method to store the reference handle passed to it as its 'i-th' reference. In its implementation of this method, the plugin should simply assign the reference handle passed in as a parameter to the member variable that holds the 'i-th' reference. Other reference handling methods such as ReferenceMaker::DeleteReference(), or ReferenceMaker::ReplaceReference() should not be called from within this method. The plugin itself or other plugins should not call this method directly. The system will call this method when a new reference is created or an existing one is replaced by calling ReferenceMaker::ReplaceReference().

Parameters:

i	- The index of the reference to store. Valid values are from 0 to NumRefs()-1.
rtarg	- The reference handle to store.

Reimplemented from SimpleWSMObject.

    {
        pblock2 = (IParamBlock2*)rtarg; 
        SimpleWSMObject::SetReference(i, rtarg);
    }

---

Member Data Documentation

IParamBlock2* pblock2

Search for all occurrences