NURBSPointConstPoint Class Reference
 
 
 
NURBSPointConstPoint Class Reference

This reference page is linked to from the following overview topics: NURBS Point Classes.


#include <surf_api.h>

Inheritance diagram for NURBSPointConstPoint:
NURBSPoint NURBSObject MaxHeapOperators

Class Description

See also:
Class NURBSObject, NURBSConst Types, Class Point3.

Description:
This class is used to create a dependent point that lies at a point or relative to it.

All methods of this class are implemented by the system.
Data Members:
protected:

NURBSId mParentId;

The id of the parent object.

int mParentIndex;

The index in the NURBSSet of the parent object.

NURBSConstType mCType;

The type of constraint in use.

Point3 mOffset;

The offset from the object that the point is.

Public Member Functions

DllExport  NURBSPointConstPoint (void)
virtual DllExport  ~NURBSPointConstPoint (void)
DllExport NURBSPointConstPoint operator= (const NURBSPointConstPoint &pt)
DllExport void  SetParent (int index)
DllExport void  SetParentId (NURBSId id)
DllExport int  GetParent (void)
DllExport NURBSId  GetParentId (void)
DllExport void  SetPointType (NURBSConstType type)
DllExport NURBSConstType  GetPointType (void)
DllExport void  SetOffset (TimeValue t, Point3 pt)
DllExport Point3  GetOffset (TimeValue t)

Protected Member Functions

DllExport void  Clean (NURBSIdTab ids)

Protected Attributes

NURBSId  mParentId
int  mParentIndex
NURBSConstType  mCType
Point3  mOffset

Friends

class  NURBSSet

Constructor & Destructor Documentation

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

mType = kNPointCPoint;

mpObject = NULL;

mpNSet = NULL;

mParentId = 0;

mParentIndex = -1;

mCType = kNConstOnObject;

mOffset = Point3(0,0,0);
virtual DllExport ~NURBSPointConstPoint ( void  ) [virtual]
Remarks:
Destructor.

Member Function Documentation

DllExport void Clean ( NURBSIdTab  ids ) [protected]
Remarks:
This methods breaks the relation between this NURBSObject and a NURBSSet.
Parameters:
NURBSIdTab ids

A table with the IDs of each object in the NURBSSet.

Reimplemented from NURBSObject.

DllExport NURBSPointConstPoint& operator= ( const NURBSPointConstPoint pt )
Remarks:
Assignment operator.
Parameters:
const NURBSPointConstPoint& pt

The construction point to assign.
DllExport void SetParent ( int  index )
Remarks:
Sets the parent index to the specified value.
Parameters:
int index

The parent index to set.
DllExport void SetParentId ( NURBSId  id )
Remarks:
Sets the parent ID to the specified value.
Parameters:
NURBSId id

The parent ID to set.
DllExport int GetParent ( void  )
Remarks:
Returnst the parent index.
DllExport NURBSId GetParentId ( void  )
Remarks:
Returns the NURBSId of the parent. Note that a NURBSId won't be valid until the object has been instantiated in the scene.
DllExport void SetPointType ( NURBSConstType  type )
Remarks:
Sets the type of point.
Parameters:
NURBSConstType type

Specifies the type of point to set. See NURBSConst Types.
DllExport NURBSConstType GetPointType ( void  )
Remarks:
Returns the type of construction point this is. See NURBSConst Types.
DllExport void SetOffset ( TimeValue  t,
Point3  pt 
)
Remarks:
Sets the offset value at the specified time.
Parameters:
TimeValue t

Specifies the time at which the offset is set.

Point3 pt

The offset value to set. This value is specified in object coordinates.
DllExport Point3 GetOffset ( TimeValue  t )
Remarks:
Returns the offset value at the specified time in object coordinates.
Parameters:
TimeValue t

The time to retrieve the offset.
Operators:

Friends And Related Function Documentation

friend class NURBSSet [friend]

Member Data Documentation