Public Member Functions | Friends

NURBSBlendCurve Class Reference

Search for all occurrences

Detailed Description

See also:
Class NURBSCurve.

Description:
This class is available in release 2.0 and later only.

This class defines a dependent blend curve. A blend curve connects the specified end of one curve to the specified end of another, blending the curvature of the parents to create a smooth curve between them. Methods are available to get/set the parent indices and ids, to get/set the ends of the curves used for the blend, and to get/set the tension values used.

All methods of this class are implemented by the system.

#include <surf_api.h>

Inheritance diagram for NURBSBlendCurve:
Inheritance graph
[legend]

List of all members.

Public Member Functions

DllExport  NURBSBlendCurve (void)
virtual DllExport  ~NURBSBlendCurve (void)
DllExport NURBSBlendCurve operator= (const NURBSBlendCurve &curve)
DllExport void  SetParent (int pnum, int index)
DllExport void  SetParentId (int pnum, NURBSId id)
DllExport int  GetParent (int pnum)
DllExport NURBSId  GetParentId (int pnum)
DllExport void  SetEnd (int pnum, BOOL end)
DllExport BOOL  GetEnd (int pnum)
DllExport void  SetTension (TimeValue t, int pnum, double ten)
DllExport double  GetTension (TimeValue t, int pnum)

Friends

class  NURBSSet

Constructor & Destructor Documentation

DllExport NURBSBlendCurve ( void  )
Remarks:
Constructor. The data members are initialized as follows:

    mType = kNBlendCurve;
    mpObject = NULL;
    mpNSet = NULL;
    for (int i = 0; i < 2; i++)
    {
        mParentId[i] = 0;
        mParentIndex[i] = -1;
        mParentEnd[i] = TRUE;
        mTension[i] = 1.0;
    }
virtual DllExport ~NURBSBlendCurve ( void  ) [virtual]
Remarks:
Destructor. The cache is cleared.

Member Function Documentation

DllExport NURBSBlendCurve& operator= ( const NURBSBlendCurve curve )
Remarks:
Assignment operator.
Parameters:
const NURBSBlendCurve& curve

The curve to assign.
DllExport void SetParent ( int  pnum,
int  index 
)
Remarks:
Sets the index in the NURBSSet of the specified parent object.
Parameters:
int pnum

The parent number: 0 or 1.

int index

The index into the NURBSSet of the parent object.
DllExport void SetParentId ( int  pnum,
NURBSId  id 
)
Remarks:
Sets the NURBSId of the specified parent.
Parameters:
int pnum

The parent number: 0 or 1.

NURBSId id

The id to set.
DllExport int GetParent ( int  pnum )
Remarks:
Returns the index in the NURBSSet of the specified parent object.
Parameters:
int pnum

The parent number: 0 or 1.
DllExport NURBSId GetParentId ( int  pnum )
Remarks:
Returns the NURBSId of the parent. Note that a NURBSId won't be valid until the object has been instantiated in the scene
Parameters:
int pnum

The parent number: 0 or 1.
DllExport void SetEnd ( int  pnum,
BOOL  end 
)
Remarks:
Sets if the beginning or end of the specified curve is used for the blend.
Parameters:
int pnum

The parent number: 0 or 1.

BOOL end

TRUE to use the end of the curve; FALSE to use the beginning. The beginning of the curve has lesser parameter values than the end.
DllExport BOOL GetEnd ( int  pnum )
Remarks:
Indicates if the beginning or end of the specified curve is used for the blend.
Parameters:
int pnum

The parent number: 0 or 1.
Returns:
TRUE if the end of the curve is used; FALSE if the beginning is used.
DllExport void SetTension ( TimeValue  t,
int  pnum,
double  ten 
)
Remarks:
Sets the tension value for the specified parent curve.
Parameters:
TimeValue t

The time at which to set the tension

int pnum

The parent number: 0 or 1.

double ten

The tension value to set.
DllExport double GetTension ( TimeValue  t,
int  pnum 
)
Remarks:
Returns the tension value for the specified parent curve.
Parameters:
TimeValue t

The time at which to get the tension

int pnum

The parent number: 0 or 1.
Operators:

Friends And Related Function Documentation

friend class NURBSSet [friend]

NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve
NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve NURBSBlendCurve