NurbsCurve Class Reference

Related Scripting Object: NurbsCurve

The NurbsCurve object gives access to the geometry curves of an X3DObject's primitive. More...

#include <xsi_nurbscurve.h>

Inheritance diagram for NurbsCurve:

Detailed Description

See also:

NurbsCurveList.GetCurves(), CNurbsCurveRefArray

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();
        CKnotArray knotArray = curve.GetKnots();

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

        knotArray.GetClosed(curveData.m_bClosed);

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

Constructor & Destructor Documentation

Default destructor.

Constructor.

Parameters:

in_ref

constant reference object.

Copy constructor.

Parameters:

in_obj

constant class object.

Member Function Documentation

Returns the type of the API class.

Returns:

The class type.

Reimplemented from SIObject.

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:

in_obj

constant class object.

Returns:

The new NurbsCurve object.

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:

in_ref

constant class object.

Returns:

The new NurbsCurve object.

Reimplemented from SIObject.

Returns an array of all Knot values on this NurbsCurve object.

Returns:

Array of knots.

Returns an array of all ControlPoint objects on this NurbsCurve object.

Returns:

Array of ControlPoint objects.

Returns a complete data description of a nurbs curve.

Parameters:

in_siNurbsFormat

Specifies how the data is formatted.

Return values:

out_curve

The entire curve data description.

Returns:

CStatus::OK success

CStatus::Fail other failure

Sets the current description from a complete data description of nurbs curve. This is only available from compiled operators; if you use it on an object with some clusters and you change the topology the burden of updating the clusters is on the user.

Parameters:

	in_curve	The new data description for this NurbsCurve.
	in_siNurbsFormat	Specifies how the data is formatted.

Returns:

CStatus::OK success

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

Returns the Position, Tangent, Normal and BiNormal at a given U value.

Parameters:

in_dUValue

The U Value at which we want to evaluate the curve.

Return values:

	out_vPosition	Position at the given U.
	out_vTangent	Tangent at the given U.
	out_vNormal	Normal at the given U.
	out_vBiNormal	Bi-Normal at the given U.

Returns:

CStatus::OK success

CStatus::Fail other failure

Returns the Position, Tangent, Normal and BiNormal at a given normalized U value.

Parameters:

in_dUNormalizedValue

The normalized UValue(0.0 to 1.0) at which we want to evaluate the curve.

Return values:

	out_vPosition	Position at the given U.
	out_vTangent	Tangent at the given U.
	out_vNormal	Normal at the given U.
	out_vBiNormal	Bi-Normal at the given U.

Returns:

CStatus::OK success

CStatus::Fail other failure

Returns a 3D vector giving the position, tangent in U direction, normal and bi-normal at a given percentage along the curve.

Parameters:

in_dPercentage

The percentange(with values between 0.0 and 100.0 inclusive) of the length of the curve at which we want to evaluate the curve.

Return values:

	out_vPosition	Position at the given percentage.
	out_vTangent	Tangent at the given percentage.
	out_vNormal	Normal at the given percentage.
	out_vBiNormal	Bi-Normal at the given percentage.

Returns:

CStatus::OK success

CStatus::Fail other failure

Returns the degree of the curve.

Return values:

out_lDegree

The degree of the curve.

Returns:

CStatus::OK success

CStatus::Fail other failure

Returns the length of the curve.

Return values:

out_dLength

The length of the curve.

Returns:

CStatus::OK success

CStatus::Fail other failure

Returns the Normalized equivalent of U value.

Parameters:

in_dUValue

The UValue from which we want the Normalized equivalent.

Return values:

out_dNormalizedUValue

The normalized U value equivalent.

Returns:

CStatus::OK success

CStatus::Fail other failure

Returns the U actual value equivalent to the specified normalized U value.

Parameters:

in_dNormalizedUValue

The normalized UValue(0.0 to 1.0) from which we want the actual value equivalent.

Return values:

out_dUValue

The actual U value equivalent.

Returns:

CStatus::OK success

CStatus::Fail other failure

Returns the U value at a certain percentage along the curve.

Parameters:

in_dPercentage

A percentage (with values between 0.0 and 100.0 inclusive) of the length of the curve.

Return values:

out_dUValue

The actual U value equivalent.

Returns:

CStatus::OK success

CStatus::Fail other failure

Returns the percentage (with values between 0.0 and 100.0 inclusive) along the curve at the given U value.

Parameters:

in_dUValue

The U value at which we want to evaluate the curve.

Return values:

out_dPercentage

The actual U value equivalent.

Returns:

CStatus::OK success

CStatus::Fail other failure

Returns the index of the NurbsCurve in the geometry's NurbsCurveList.

Returns:

The NurbsCurve index

-1 if the NurbsCurve object is not initialized.

Creates a SubComponent object from this NurbsCurve object.

Returns:

A SubComponent object.

Navigates the NurbsCurve objects of the underlying geometry as specifed by the navigation component type. The navigation is circular, therefore if you ask for siNextComponent on the last NurbsCurve it returns the first NurbsCurve.

Parameters:

in_siNavigate

Type of direction for navigating the Facet objects.

Returns:

The Point object being visited.

• xsi_nurbscurve.h