CSampleRefArray Class Reference

Related Scripting Object: SampleCollection

Array of Sample objects that represent the samples in the Geometry. More...

#include <xsi_sample.h>

Inheritance diagram for CSampleRefArray:

Detailed Description

Warning:

This specialized array is returned by Facet::GetSamples, Segment::GetSamples and Point::GetSamples, it is not meant to be created and modified in user-defined functions. If you want to add and remove arbitrary items to a collection, you must use a CRefArray instead.

See also:

Facet::GetSamples, Segment::GetSamples, Point::GetSamples

Example:

        using namespace XSI;
        Application app;
        Model root = app.GetActiveSceneRoot();

        X3DObject myCube;
        root.AddGeometry( L"Cube", L"MeshSurface", L"", myCube );

        CSampleRefArray samples( myCube.GetActivePrimitive().GetGeometry().GetSamples() );

        CLongArray indexArray = samples.GetIndexArray();

        for (LONG i=0; i< indexArray.GetCount(); ++i )
        {
            app.LogMessage( L"Sample.Index " +
                            CValue(indexArray[i]).GetAsText() );
        }

Constructor & Destructor Documentation

Member Function Documentation

Returns a reference to the Sample object specified by name.

Parameters:

in_name

The name of the Sample to get.

Returns:

The Sample object.

Reimplemented from CRefArray.

Reimplemented in CNurbsSampleRefArray, and CPolygonNodeRefArray.

Returns the number of Sample objects in the array.

Returns:

The number of Sample objects.

Reimplemented from CRefArray.

Reimplemented in CNurbsSampleRefArray, and CPolygonNodeRefArray.

Returns true if this array is a valid object or false otherwise.

Returns:

true if valid, false otherwise.

Reimplemented from CRefArray.

Reimplemented in CNurbsSampleRefArray, and CPolygonNodeRefArray.

Returns an array of indices of all Sample objects relative to the Facet object.

Returns:

Array of indices.

Creates a SubComponent object from this Sample array,

Returns:

A SubComponent object

Navigates the Sample objects of the underlying geometry as specifed by the navigation component type. An array of Sample objects corresponding to each Sample object visited is returned. Navigation is circular -- for instance, navigating beyond the last component will return the first and vice versa.

Parameters:

in_siNavigate

Type of direction for navigating the Sample objects.

Returns:

An array of Sample objects.

• xsi_sample.h