CIndexSet Class Reference

#include <xsi_indexset.h>

List of all members.

Public Member Functions
SICPPSDK_INLINE	CIndexSet (const ICENodeContext &in_ctxt)
SICPPSDK_INLINE	CIndexSet (const ICENodeContext &in_ctxt, ULONG in_nInputPortID, ULONG in_nInstanceIndex=0)
SICPPSDK_INLINE	~CIndexSet ()
SICPPSDK_INLINE Iterator	Begin ()
Classes
class	Iterator
	A class for iterating over CDataArray objects during an evaluation. Iterator objects must always be created with CIndexSet::Begin(). More...

Detailed Description

Example:

    XSIPLUGINCALLBACK CStatus YPosFilter_Evaluate( ICENodeContext& in_ctxt )
    {
        // The current output port being evaluated...
        ULONG out_portID = in_ctxt.GetEvaluatedOutputPortID( );

        switch( out_portID )
        {
            case OutPort200:
            {
                CDataArrayVector3f inputData( ctxt, InPort0 );
                CDataArrayVector3f outData( ctxt );

                // We need a CIndexSet to iterate over the data
                CIndexSet indexSet( in_ctxt );

                for(CIndexSet::Iterator it = indexSet.Begin(); it.HasNext(); )
                {
                    outData[ it ] = inputData[ it ];

                    if ( inputData[it].GetY() < 0.0 )
                    {
                        it.Remove( );
                    }
                    else
                    {
                        it.Next( );
                    }
                }
            }
            break;
        };

        return CStatus::OK;
    }

Since:

7.0

See also:

CIndexSet::Iterator, CDataArray, CDataArray2D

Constructor & Destructor Documentation

Constructor. Creates the index set for a specific port.

Note:

The CIndexSet created can not be used to set the output port data array and is only valid when the underlying custom ICENode is set with the siICENodeSingleThreading or siICENodeMultiEvaluationPhase mode. The object created is read-only, indices cannot be removed with CIndexSet::Iterator::Remove.

Parameters:

	in_ctxt	ICENode evaluation context.
	in_nInputPortID	Input port identifier.
	in_nInstanceIndex	The group instance of the port.

Destructor.

Member Function Documentation

• xsi_indexset.h