GL Studio C++ Runtime API
GlsNurbCurve Class Reference

#include <gls_nurb_curve.h>

Inheritance diagram for GlsNurbCurve:
DisplayObject AttributeChangedNotifier WeakReferenceableMixin WeakReferenceable

Public Member Functions

 GlsNurbCurve (unsigned int nPoints, Vertex *vertices)
 GlsNurbCurve (bool generateInstanceName=false)
 GlsNurbCurve (unsigned int n_points, Vertex *vertices, Vertex &location)
virtual ~GlsNurbCurve ()
void GenerateTessellatedVertices (void)
unsigned int NumberOfTessVertices () const
VertexTessVertices ()
virtual void SetAvailableAttributes (unsigned int availableAttributes)
virtual DisplayObjectCloneObject (bool generateNames=false)
virtual void CopyGeometry (DisplayObject *src)
virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array)
virtual void PreDraw (const OpenGLMatrices &parentMatrices, Culler &culler)
virtual void Draw (void)
virtual void CalcNormals (int windingOrder=1)
virtual void SetVertices (unsigned int nPoints, Vertex *vertices)
virtual void VaListSetVertices (unsigned int nPoints, va_list args)
void Scale (float px, float py, float pz, Vertex *a, int handleBar)
virtual void CalculateTextureCoordinates (void)
virtual void Rotate (const Vector &orig, float angle, const Vector &axis)
virtual void GetExtents (float &x, float &y, float &z, float &x1, float &y1, float &z1)
virtual bool Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint)
virtual void DeleteVertex (unsigned int index)
virtual void SetVertexColor (unsigned int index, unsigned char col[])
virtual void SetFillColor (const GlsColor &color)
- Public Member Functions inherited from DisplayObject
 DisplayObject (float x, float y, float z)
 DisplayObject (const DisplayObject &object, const bool generateNames)
virtual ~DisplayObject (void)
void Destroy ()
virtual void AlphaMode (int mode)
virtual int AlphaMode (void)
virtual bool AntiAlias (void)
virtual void AntiAlias (bool alias)
void ApplyTextureSettings (int textureIndex=-1)
DistiAttribDictAttributes ()
virtual void SetBlendColor (const GlsColor &color)
void GetBlendColor (unsigned char color[])
void GetBlendColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
virtual GlsColor GetBlendColor ()
void SetBlendColor (unsigned char color[])
void SetBlendColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
bool BlinkedOff (void)
virtual bool Blinking (void)
virtual void Blinking (const bool blink)
virtual float BlinkRate (void)
virtual void BlinkRate (const float rate)
const VectorBoundingVolumeCenter () const
void BoundingVolumeCenter (const Vector &center)
bool BoundingVolumeHit (const Vector &start, const Vector &direction)
float BoundingVolumeRadius () const
void BoundingVolumeRadius (float radius)
virtual void Calculate (double time)
void CalculateCollisionPoint (const Vector &pickLoc, const Vector &directionVector, Vector *collisionPoint)
virtual void CalculateParentBoundingBox (void)
bool GetTexturePointTransformationMatrix (GlsMatrixType &world2tex)
CallbackMethodCallerBaseCallbackCaller () const
void CallbackCaller (CallbackMethodCallerBase *cb)
virtual void GetCenter (Vector &center)
virtual GlsColor GetColor ()
void GetColor (unsigned char c4[])
void GetColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
virtual void SetColor (const GlsColor &color)
void SetColor (unsigned char c4[])
void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
virtual void CopyHierarchyProperties (DisplayObject *src, bool copyName)
virtual void CopyProperties (DisplayObject *src)
virtual void CullBackFace (const bool val)
virtual bool CullBackFace (void)
bool Culled () const
bool CullTest (const GlsMatrixType *matrix, const Culler &culler)
GlsMatrixTypeDcsMatrix ()
void DcsMatrix (const GlsMatrixType &matrix)
virtual int DepthTest (void)
virtual void DepthTest (unsigned char zbuf)
const GlsMatrixTypeDrawMatrix ()
bool NeedCalcDrawMatrix ()
void DynamicRotate (float angle, int axis)
void DynamicRotate (const Vector &v)
void DynamicRotate (float angle[])
virtual void DynamicRotate (float x, float y, float z)
virtual void DynamicRotateRelative (float angle, int axis)
virtual float DynamicRotation (int axis)
virtual Vector DynamicScale ()
virtual void DynamicScale (float x, float y, float z)
void DynamicScale (const Vector &scale)
virtual void DynamicTranslate (float x, float y, float z, bool relative=false)
void DynamicTranslate (const Vertex &amount, bool relative)
void DynamicTranslate (const Vector &amount)
virtual void DynamicTranslate (float amount, int axis, bool relative=false)
virtual float DynamicTranslation (int axis)
virtual Vector DynamicTranslation ()
DisplayObjectEditor * Editor ()
const DisplayObjectEditor * Editor () const
void Editor (DisplayObjectEditor *editor)
void GetExtentsDCS (Vector &min, Vector &max)
void GetFillColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
void GetFillColor (unsigned char c4[])
virtual GlsColor GetFillColor (void)
void SetFillColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
void SetFillColor (unsigned char c4[])
virtual DisplayObjecthandle (DisplayEvent *ev)
virtual bool HitUtil (float x, float y, float z, float scale, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector, Vector *collisionPoint)
virtual void InsertVertex (unsigned int index)
char * InstanceName (void)
void InstanceName (const char *name)
virtual bool LightingEnabled ()
virtual void LightingEnabled (bool lighting)
virtual int LineStippleMultiplier (void)
virtual void LineStippleMultiplier (int mult)
virtual int LineStipplePattern (void)
virtual void LineStipplePattern (int pattern)
virtual float LineWidth (void)
virtual void LineWidth (float width)
virtual const VertexLocation (void) const
virtual void Location (const Vertex &v)
virtual void Location (float x, float y, float z)
virtual void GetLocation (Vertex &v)
virtual void GetLocation (float &x, float &y, float &z)
float X (void) const
float Y (void) const
float Z (void) const
void X (const float x)
void Y (const float y)
void Z (const float z)
virtual int MaterialIndex ()
virtual void MaterialIndex (int index)
virtual DynamicArray< int > & MaterialIndices ()
virtual void MaterialIndices (DynamicArray< int > indices)
GlsMatrixTypeModelMatrix ()
bool NeedCalculate ()
VectorNormals ()
virtual void SetNormals (unsigned int nPoints, Vector *vertices)
void VaSetNormals (unsigned int nPoints,...)
unsigned int NumberOfVertices () const
virtual float ObjectDepth (void)
virtual float ObjectHeight (void)
virtual float ObjectWidth (void)
virtual void SetOrigin (const Vertex &vert)
virtual void Parent (DisplayFrame *par)
DisplayFrameParent (void) const
virtual void ParentGroup (Group *group)
GroupParentGroup (void) const
virtual DisplayObjectPick3D (const Vector &winLoc, const Vector &logicalCoords, float scale, const Vector &directionVector, Vector &collisionWinLoc, const OpenGLMatrices &drawnMatrices)
unsigned char Pickable ()
virtual void Pickable (unsigned char pick)
virtual int PolygonEnd (void)
virtual void PolygonEnd (const int end)
virtual int PolygonMode (void)
virtual void PolygonMode (int mode)
GlsMatrixTypeProjMatrix ()
virtual void ReallocateVertices (unsigned int numVertices, bool initializeNew, bool copyOld)
virtual float RelativeAngle (const float x, const float y)
virtual DistiAttributeBaseResource (const char *name)
virtual void GetResources (std::ostream &outstr, GlsResourceFilter *filter=NULL)
void RestoreAlpha (void)
void RestoreAntiAlias (void)
void RestoreLighting (void)
void RestoreLineStyle (void)
const VertexRotationPoint ()
virtual void RotationPoint (const Vertex &v)
virtual void RotationPoint (float x, float y, float z)
virtual void GetRotationPoint (Vertex &v)
virtual void Rotate (float angle, int axis=Z_AXIS)
virtual void Rotate (const Vector &origin, float angle, int axis=Z_AXIS)
void SaveMatrices ()
void Scale (int handleBar, float px, float py, Vertex *anchor=NULL)
void Set (int spec,...)
bool SetupAlpha (void)
bool SetupAntiAlias (void)
void SetupDepthTest (void)
void SetupLighting (void)
bool SetupLineStyle (void)
void SetupPolyDrawStyle (void)
void SetupShading (void)
bool SetupTexture (void)
virtual int Shading (void)
virtual void Shading (const int shading)
virtual void GetTransformedExtents (Vector &min, Vector &max, const GlsMatrixType &matrix, bool resetMinMax=true)
virtual void SetTexCoords (unsigned int nPoints, Vector *new_tex_coord, bool isVectorArray=true)
void SetTexCoords (unsigned int nPoints, Vertex *new_tex_coord)
void VaSetTexCoords (unsigned int nPoints,...)
VectorTextureCoordinates (void)
VectorGetTextureCoordinates (void)
virtual int TextureIndex (void)
virtual void TextureIndex (int textureIndex)
virtual VectorGetTexturePoints (void)
virtual bool TextureRepeat (void)
virtual void TextureRepeat (const int rep)
virtual int TextureMappingTechnique (void)
virtual void TextureMappingTechnique (const int map)
virtual int TextureMagnificationFilter (void)
virtual void TextureMagnificationFilter (const int filter)
virtual int TextureMinificationFilter (void)
virtual void TextureMinificationFilter (const int filter)
virtual void Translate (float tr[])
virtual void Translate (float x, float y, float z)
virtual void TranslateVertices (float x, float y, float z)
virtual void UpdateBoundingVolume (void)
void * UserData (void) const
void UserData (void *data)
virtual VertexVertices ()
void VaSetVertices (unsigned int nPoints,...)
int * ViewMatrix ()
bool Visible (void) const
bool Visibility (void) const
virtual void Visibility (const bool vis)
virtual Vector WorldRotationPoint (void)
virtual void WorldRotationPoint (const Vector &vert)
virtual Vertex WorldVertex (unsigned int i)
virtual void WorldVertex (unsigned int i, const Vertex &vert)
bool LogicalToWindow (const Vector &logical, Vector &winLoc, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())
bool WindowToLogical (const Vector &winLoc, Vector &logical, Vector *directionVector=NULL, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())
void LogicalToDCS (Vector logicalPoint, Vector &objectLocal, const Vector *directionVector, const Vector &planeNormal=Vector(0, 0, 1), const Vector &planePoint=Vector(), const GlsMatrixType *dcsMatrix=NULL)
void DCSToLogical (Vector dcsPoint, Vector &logicalPoint, const GlsMatrixType *dcsMatrix=NULL)
virtual bool GetPlaneVectorPoints (Vertex &p1, Vertex &p2, Vertex &p3, Vertex &planeVector)
void NotifyAttributeChanged (const AttributeName &name)
- Public Member Functions inherited from AttributeChangedNotifier
virtual ~AttributeChangedNotifier ()
- Public Member Functions inherited from WeakReferenceableMixin
void AddWeakReference (WeakReference *weakRef)
void NotifyWeakReferenceDestroyed (WeakReference *ref)

Additional Inherited Members

- Public Types inherited from DisplayObject
enum  AvailableAttributesEnum
- Static Public Member Functions inherited from DisplayObject
static void UseManualBlinkElapsedTime (bool useManualTime)
static void SetManualBlinkElapsedTime (double elapsedTime)
- Protected Member Functions inherited from DisplayObject
virtual void VaListSetNormals (unsigned int nPoints, va_list args)
virtual void VaListSetTexCoords (unsigned int nPoints, va_list args)
void AllocateModelMatrix ()
bool ApplyDynamicRotation (void)
virtual void CalcDrawMatrix ()
void CalcDrawMatrixIfExists ()
virtual void CalculateMatrices (const OpenGLMatrices &newMatrices)
bool InsideVertexExtents (float x, float y, unsigned int nVerts, Vertex *verts, float tolerance)
void NeedCalculate (bool val)
void PickSetup (float x, float y, float z, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector)
void PickCleanup (Vertex *vertices, unsigned int vertex_cnt)
virtual void SetValue (int spec, va_list &args)
int GetApplicableTextureIndex ()
int GetApplicableTextureRepeat ()
- Protected Member Functions inherited from WeakReferenceableMixin
 WeakReferenceableMixin (void)
virtual ~WeakReferenceableMixin ()
- Protected Attributes inherited from DisplayObject
int _alphaMode
bool _antiAlias
bool _attributesAdded
bool _blinking
float _blinkRate
GlsColor _color
bool _cullBackFace
GlsMatrixType _dcsMatrix
unsigned char _depthTest
unsigned char _lineStippleMultiplier
unsigned short _lineStipplePattern
float _lineWidth
Vertex _location
unsigned int _nTex_vertices
unsigned int _nVertices
unsigned char _polygonEnd
unsigned char _polygonMode
int _polygonOffset
unsigned char _shading
GlsColor _textureBlendColor
int _textureIndex
unsigned char _textureMagFilter
unsigned char _textureMinFilter
unsigned char _textureMap
Vector _texturePoints [4]
unsigned char _textureRepeat
void * _userData
int * _viewMatrix
bool _visible
- Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * _weakRefs

Detailed Description

Runtime implementation of a GlsNurbCurve

Constructor & Destructor Documentation

GlsNurbCurve ( unsigned int  nPoints,
Vertex vertices 

Creates a NURB Curve with the vertices specified

nPointsNumber of control points in the NURB
verticesAn array of allocated vertices
vertices is not NULL
GlsNurbCurve ( bool  generateInstanceName = false)

Allocate a (blank) NURB Curve object

GlsNurbCurve ( unsigned int  n_points,
Vertex vertices,
Vertex location 

NurbCurve Constructor. Creates a new NURBCurve object with the number of vertices and vertex data specified.

n_pointsNumber of control points in the NURB
verticesAn array of allocated vertices
locationInitial location of the NURB
virtual ~GlsNurbCurve ( )

Destructs a GlsNurbCurve object

Member Function Documentation

virtual void CalcNormals ( int  windingOrder = 1)

Calculates normals based on the vertices and the specified winding order

virtual void CalculateTextureCoordinates ( void  )

Recalculates the texture coordinates for the object based on the TexturePoints.

Reimplemented from DisplayObject.

virtual DisplayObject* CloneObject ( bool  generateNames = false)

Copy+Create operation in one method. In derived classes, this method will create a new instance of the derived class and then copy the object into the new instance. The cut,copy,paste and undo operations use this method.

generateNamesWhether or not to generate new names for cloned objects
A new object, identical to the original, except for the instance name

Implements DisplayObject.

virtual void CopyGeometry ( DisplayObject src)

Copies the geometry information from one object to another. Used by the undo mechanism to allow user to undo a geometry change.

srcThe object to copy geometry from

Reimplemented from DisplayObject.

virtual void DeleteVertex ( unsigned int  index)

Remove the Vertex at the given index. This causes tesselated vertices to be recalculated.

indexThe index to remove (1 based)

Reimplemented from DisplayObject.

virtual void Draw ( void  )

Draws this object on the current display frame (_parent member). Pure virtual method

Implements DisplayObject.

void GenerateTessellatedVertices ( void  )

Generate a list of vertices describing the NURB curve, save those vertices in the NURBCurve object for use in drawing.

virtual InterfaceListType* GetCppInterfaceDescription ( InterfaceListType addToThisList = NULL)

Get the details of the Cpp Interface The actual interface is exposed in compiled code.

addToThisListIf not NULL this list will be added to then returned. If NULL a new list will be created.
A templated list. The caller must call the corresponding free method to safely free the memory.

Reimplemented from DisplayObject.

virtual void GetCppInterfaceDescriptionFree ( InterfaceListType array)

Frees the memory allocated by a previous call to GetCppInterfaceDescription

arrayMemory allocated by a previous call to GetCppInterfaceDescription

Reimplemented from DisplayObject.

virtual void GetExtents ( float &  x,
float &  y,
float &  z,
float &  x1,
float &  y1,
float &  z1 

Figure out the static extents for the object. Used by the editor as part of the pick operation and for figuring out the size of groups.

xGets the minimum x extent
yGets the minimum y extent
zGets the minimum z extent
x1Gets the maximum x extent
y1Gets the maximum y extent
z1Gets the maximum z extent

Reimplemented from DisplayObject.

virtual bool Hit ( float  x,
float  y,
float  z,
float  scale,
const Vector directionVector,
Vector collisionPoint 

Determines if the object is hit by a pick ray starting at (x,y,z) and pointing towards directionVector in object logical coordinate system. If Pickable() == PICK_BEST it will return the closest point that was hit, otherwise it returns the first point that was hit. This method should not pick points behind the viewer.

xX coordinate of pick ray start in logical coordinates.
yY coordinate of pick ray start in logical coordinates.
yY coordinate of pick ray start in logical coordinates.
zZ coordinate of pick ray start in logical coordinates.
scaleThe scale factor of the window. Affects picking of outlines. Standard value is 1.0.
directionVectorThe direction of the pick ray.
collisionPointIf this method returns true, this Vector will contain the location that was hit in logical coordinates.
boolean indicating if the object was hit by the pick ray.

Reimplemented from DisplayObject.

unsigned int NumberOfTessVertices ( ) const

Gets the object's number of Tesselated vertices. These tesselated vertices are generated by the NURB render function.

The number of vertices in the object
virtual void PreDraw ( const OpenGLMatrices current,
Culler culler 

Traverses the hierarchy calculating the _modelMatrix, _projMatrix, _viewMatrix as needed.

currentCurrent matrices inherited from parent
cullerObject that possibly marks this object for culling

Reimplemented from DisplayObject.

virtual void Rotate ( const Vector orig,
float  angle,
const Vector axis 

Rotates the object (around the specified axis) by the angle indicated, at the point specified. Recalculates the vertex data.

origThe point to rotate around
angleThe angle to rotate by, in degrees
axisThe arbitrary axis to rotate the object around

Reimplemented from DisplayObject.

void Scale ( float  px,
float  py,
float  pz,
Vertex anchor,
int  handleBar 

Scales the object, either the handleBar, or the Anchor is used to translate the object, not both. Anchor takes presidence, if it is set HandleBar is ignored. The footprint is different from the 2D scale so the compiler can destinguish the two.

pxValue of the percentage of scale in x-axis
pyValue of the percentage of scale in y-axis
pzValue of the percentage of scale in z-axis
anchorAnchor from which to scale object relative to
handleBarVertex that is being dragged

Reimplemented from DisplayObject.

virtual void SetAvailableAttributes ( unsigned int  value)

Specifies which attributes are available for the object. Currently the available attributes cannot be changed after they have been set. (Only the first call has an effect.)

valueA bitfield specifying which types of attributes to make available.
See also

Reimplemented from DisplayObject.

virtual void SetFillColor ( const GlsColor color)

Sets the RGBA color for filling the object

colorThe new RGBA fill color (0-255 range) for the object

Reimplemented from DisplayObject.

virtual void SetVertexColor ( unsigned int  vertex,
unsigned char  CurrentFillColor[] 

Changes the color of a vertex

vertex1 based index of the vertex to the change color for
CurrentFillColorThe new RGBA (0-255 range) color for the vertex

Reimplemented from DisplayObject.

virtual void SetVertices ( unsigned int  nPoints,
Vertex vertices 

Sets the vertex data for this polygon You should call UpdateBoundingVolume after changing an objects extents.

See also
nPointsThe number of vertices in the object
verticesThe vertex data for the object

Reimplemented from DisplayObject.

Vertex* TessVertices ( )

Gets the object's tesselated vertices.

Pointer the the object's tesselated vertices
virtual void VaListSetVertices ( unsigned int  nPoints,
va_list  args 

Sets the vertex data for this object You should call UpdateBoundingVolume after changing an objects extents.

See also
nPointsThe number of vertices in the object
argsva_list in the form r,g,b,a,x,y,z for each vertex

Reimplemented from DisplayObject.

The documentation for this class was generated from the following file: