CControlPointRefArray Class Reference

Related Scripting Object: ControlPointCollection

An array of ControlPoint object references representing the NurbsCurve or NurbsSurface control points. More...

#include <xsi_controlpoint.h>

Inheritance diagram for CControlPointRefArray:

Detailed Description

Warning:

This specialized array is returned by NurbsCurve::GetControlPoints and NurbsSurface::GetControlPoints, 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:

NurbsCurve::GetControlPoints, NurbsSurface::GetControlPoints, ControlPoint, CNurbsCurveData, CNurbsSurfaceData

Example:

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

        X3DObject circle;
        root.AddGeometry(L"Circle",L"NurbsCurve",L"",circle);

        NurbsCurveList curveList = circle.GetActivePrimitive().GetGeometry();

        NurbsCurve curve = curveList.GetCurves().GetItem(0);

        CControlPointRefArray cpArray = curve.GetControlPoints();

        CNurbsCurveData curveData;
        cpArray.GetArray(curveData.m_aControlPoints);

        curveData.m_bClosed = true;

        X3DObject circleCopyWithoutKnots;
        root.AddNurbsCurve(curveData,siSINurbs,L"",circleCopyWithoutKnots);

Constructor & Destructor Documentation

Default destructor.

Copy constructor.

Parameters:

in_array

constant CControlPointRefArray reference object.

Member Function Documentation

Returns the NurbsCurve object in the array matching the specified name.

Parameters:

in_name

The name of the NurbsCurve.

Returns:

A reference to the NurbsCurve object.

Reimplemented from CPointRefArray.

Returns the number of NurbsSurface objects in the array.

Returns:

The number of NurbsSurface objects.

Reimplemented from CPointRefArray.

Returns whether this array is a valid object.

Returns:

true if valid, false otherwise.

Reimplemented from CPointRefArray.

Returns an array of control points for this nurbs component.

Return values:

out_vPositions

An array of positions for the control points.

Returns:

CStatus::OK success.

CStatus::Fail other failure.

Sets an array of control points for this nurbs component. This function can only be used within a compiled operator or if no operators are attach to this geometry.

Parameters:

in_vPositions

The new positions for the control points.

Returns:

CStatus::OK success.

CStatus::CStatus::AccessDenied function used outside of a plug-in operator context.

Returns the size of the ControlPoint reference array in a particular direction. For NurbsCurves use siUDirection.

Parameters:

in_siDirection

Direction of dimension required (one of the siNurbsDirection values).

Return values:

out_lDimension

The actual dimension.

Returns:

CStatus::OK success.

CStatus::InvalidArgument if the direction is invalid for this type of component (for example, siVDirection for a NurbsCurve).

• xsi_controlpoint.h