MudboxCurve Class Reference
Detailed Description
#include <curve.h>
Public Types |
|
| enum | CurveType { CT_3D = 0, CT_2D } |
|
Curve type. Used to determine if curve is treated as a ViewCurve (2D) or a regular 3D curve. More... |
|
Public Member Functions |
|
| MudboxCurve () | |
| virtual | ~MudboxCurve () |
| virtual int | AddPoint (const CurvePoint &pt) |
| Add 3D world space point to end of point
list. |
|
| virtual bool | SetPoint (int index, const CurvePoint &pt) |
| Replaces existing point to the values passed
in. |
|
| virtual bool | SetPoint (int index, const Vector &pt) |
| Replaces existing point to the values passed
in. |
|
| virtual const CurvePoint & | Point (int index) const |
| Returns the 3D world space point from
specified index. |
|
| virtual Vector | WorldPosition (int iIndex) const |
| Returns the world space position of the
specified point. |
|
| virtual int | PointCount () const |
| Returns the number of points. |
|
| virtual bool | Point (int index, CurvePoint &point) |
| Sets the input to the 3D world space point
at index. |
|
| virtual const QList< CurvePoint > & | Points () |
| Returns the array of points. |
|
| virtual bool | InsertPoint (int before, const CurvePoint &pt) |
| Insert 3D world space point into point list.
|
|
| virtual bool | RemovePoint (int index) |
| Removes 3D world space point at index.
|
|
| virtual void | Serialize (Stream &s) |
| Serialize the node. |
|
| virtual
const AxisAlignedBoundingBox & |
BoundingBox () |
| Return world space bounding box. |
|
| virtual void | CopyTo (Node *pNode) const |
| Copies Curve into another Curve (pNode must
be Curve type) |
|
| virtual bool | IsConstrainedToSurface (void) const |
| TODO. |
|
| virtual void | CreateSpline (float fSmoothness) |
| Creates a NURBS curve. |
|
| virtual void | BeginEdit () |
| Pauses any updating of the spline or any
other automatic updating while adding points. |
|
| virtual void | EndEdit () |
| Updates & resumes any auto updating.
|
|
| virtual NURBSCurve * | Spline () const |
| Returns the internal spline representation
if it exists. |
|
| virtual bool | IsSpline (void) const |
| Returns true if a NURBS representation
exists for this Curve. |
|
| virtual void | ProjectPoint (const Vector &vPoint, Vector &vResult) const |
| Project a point onto the curve. |
|
| virtual void | SetCurveType (enum CurveType ct) |
| Sets the curve type. Can be 3D or 2D. At
this time, only affects how curve is edited and rendered. |
|
| virtual enum CurveType | CurveType () const |
| Returns the Curve type. |
|
| virtual NURBSCurve * | FalloffCurve () |
| Returns the fall off curve used for certain
operations on this Curve. |
|
Protected Attributes |
|
| QList< CurvePoint > | m_vPoints |
| Using QList for storage. |
|
| enum CurveType | m_eCurveType |
Member Enumeration Documentation
| enum CurveType |
Curve type. Used to determine if curve is treated as a ViewCurve (2D) or a regular 3D curve.
Constructor & Destructor Documentation
| MudboxCurve | ( | ) |
| virtual ~MudboxCurve | ( | ) | [virtual] |
Member Function Documentation
| virtual int AddPoint | ( | const CurvePoint & | pt | ) | [virtual] |
Add 3D world space point to end of point list.
Returns index of added point.
| virtual bool SetPoint | ( | int | index, |
| const CurvePoint & | pt | ||
| ) | [virtual] |
Replaces existing point to the values passed in.
Returns true on success, false on failure.
| virtual bool SetPoint | ( | int | index, |
| const Vector & | pt | ||
| ) | [virtual] |
Replaces existing point to the values passed in.
Returns true on success, false on failure.
| virtual const CurvePoint& Point | ( | int | index | ) | const [virtual] |
Returns the 3D world space point from specified index.
No fail condition.
| virtual Vector WorldPosition | ( | int | iIndex | ) | const [virtual] |
Returns the world space position of the specified point.
| virtual int PointCount | ( | ) | const [virtual] |
Returns the number of points.
| virtual bool Point | ( | int | index, |
| CurvePoint & | point | ||
| ) | [virtual] |
Sets the input to the 3D world space point at index.
Returns true if succeeded or false if failed.
| virtual const QList<CurvePoint>& Points | ( | ) | [virtual] |
Returns the array of points.
| virtual bool InsertPoint | ( | int | before, |
| const CurvePoint & | pt | ||
| ) | [virtual] |
Insert 3D world space point into point list.
Returns true if successful, otherwise false.
| virtual bool RemovePoint | ( | int | index | ) | [virtual] |
Removes 3D world space point at index.
Returns true if successful, otherwise false.
| virtual void Serialize | ( | Stream & | s | ) | [virtual] |
| virtual const AxisAlignedBoundingBox& BoundingBox | ( | ) | [virtual] |
| virtual void CopyTo | ( | Node * | pNode | ) | const [virtual] |
Copies Curve into another Curve (pNode must be Curve type)
Reimplemented from CurveBase.
| virtual bool IsConstrainedToSurface | ( | void | ) | const [virtual] |
| virtual void CreateSpline | ( | float | fSmoothness | ) | [virtual] |
Creates a NURBS curve.
| virtual void BeginEdit | ( | ) | [virtual] |
Pauses any updating of the spline or any other automatic updating while adding points.
| virtual void EndEdit | ( | ) | [virtual] |
Updates & resumes any auto updating.
| virtual NURBSCurve* Spline | ( | ) | const [virtual] |
Returns the internal spline representation if it exists.
Returns NULL if spline does not exist. Makes IsSpline somewhat redundant.
| virtual bool IsSpline | ( | void | ) | const [virtual] |
Returns true if a NURBS representation exists for this Curve.
Project a point onto the curve.
| virtual void SetCurveType | ( | enum CurveType | ct | ) | [virtual] |
Sets the curve type. Can be 3D or 2D. At this time, only affects how curve is edited and rendered.
Returns the Curve type.
| virtual NURBSCurve* FalloffCurve | ( | ) | [virtual] |
Returns the fall off curve used for certain operations on this Curve.
Member Data Documentation
QList<CurvePoint>
m_vPoints [protected] |
Using QList for storage.
Ultimately not the fastest method of storing but allows faster insert & deletions of points.
enum
CurveType
m_eCurveType [protected] |
The documentation for this class was generated from the following file:
- Mudbox/curve.h
