Open Inventor Reference
SoShapeHintsElement Class Reference

Element that stores current shape hints. More...

#include <Inventor/elements/SoShapeHintsElement.h>

Inheritance diagram for SoShapeHintsElement:
SoElement SoGLShapeHintsElement

List of all members.

Public Types

enum  VertexOrdering { UNKNOWN_ORDERING, CLOCKWISE, COUNTERCLOCKWISE, ORDERING_AS_IS }
 Hints about ordering of face vertices: More...
enum  ShapeType { UNKNOWN_SHAPE_TYPE, SOLID, SHAPE_TYPE_AS_IS }
 Hints about entire shape: More...
enum  FaceType { UNKNOWN_FACE_TYPE, CONVEX, FACE_TYPE_AS_IS }
 Hints about faces of shape: More...

Public Member Functions

virtual void init (SoState *state)
 Initializes element.
virtual void push (SoState *state)
 Push copies the values from the previous element, so set doesn't have to set them if they are set AS_IS.
virtual SbBool matches (const SoElement *elt) const
 Returns TRUE if the hints match in both elements.
virtual SoElementcopyMatchInfo () const
 Create and return a copy of this element.
virtual void print (FILE *fp) const
 Prints element (for debugging)

Static Public Member Functions

static void set (SoState *state, VertexOrdering vertexOrdering, ShapeType shapeType, FaceType faceType)
 Sets the current shape hints in the state.
static void set (SoState *state, SbBool useVBO)
 Sets the VBO usage in the state.
static void set (SoState *state, SoNode *, VertexOrdering vertexOrdering, ShapeType shapeType, FaceType faceType)
static void get (SoState *state, VertexOrdering &vertexOrdering, ShapeType &shapeType, FaceType &faceType)
 Returns current shape hints from the state.
static SbBool isVBOUsed (SoState *state)
static VertexOrdering getDefaultVertexOrdering ()
 Returns each default hint.
static ShapeType getDefaultShapeType ()
static FaceType getDefaultFaceType ()
static SbBool getDefaultVBOUsage ()
static void initClass ()
 Initializes the SoShapeHintsElement class.

Protected Member Functions

virtual void setElt (VertexOrdering vertexOrdering, ShapeType shapeType, FaceType faceType)
 Virtual set methods that subclasses can override.
virtual ~SoShapeHintsElement ()

Protected Attributes

VertexOrdering vertexOrdering
ShapeType shapeType
FaceType faceType
SbBool useVBO

Detailed Description

All three hints must be set at the same time; to leave any hint as is, use the "AS_IS" enum value.

Definition at line 71 of file SoShapeHintsElement.h.


Member Enumeration Documentation

Enumerator:
UNKNOWN_FACE_TYPE 

Nothing is known about faces.

CONVEX 

Faces are all convex.

FACE_TYPE_AS_IS 

Indicates to set() to leave as is.

Definition at line 92 of file SoShapeHintsElement.h.

Enumerator:
UNKNOWN_SHAPE_TYPE 

Nothing is known about shape.

SOLID 

Shape is known to be solid.

SHAPE_TYPE_AS_IS 

Indicates to set() to leave as is.

Definition at line 85 of file SoShapeHintsElement.h.

Enumerator:
UNKNOWN_ORDERING 

No ordering info is known.

CLOCKWISE 

Vertices are ordered CW around faces.

COUNTERCLOCKWISE 

Vertices are ordered CCW around faces.

ORDERING_AS_IS 

Indicates to set() to leave as is.

Definition at line 77 of file SoShapeHintsElement.h.


Constructor & Destructor Documentation

virtual SoShapeHintsElement::~SoShapeHintsElement ( ) [protected, virtual]

Member Function Documentation

virtual SoElement* SoShapeHintsElement::copyMatchInfo ( ) const [virtual]

Implements SoElement.

static void SoShapeHintsElement::get ( SoState state,
VertexOrdering vertexOrdering,
ShapeType shapeType,
FaceType faceType 
) [static]
static FaceType SoShapeHintsElement::getDefaultFaceType ( ) [inline, static]

Definition at line 126 of file SoShapeHintsElement.h.

static ShapeType SoShapeHintsElement::getDefaultShapeType ( ) [inline, static]

Definition at line 125 of file SoShapeHintsElement.h.

static SbBool SoShapeHintsElement::getDefaultVBOUsage ( ) [inline, static]

Definition at line 127 of file SoShapeHintsElement.h.

References TRUE.

static VertexOrdering SoShapeHintsElement::getDefaultVertexOrdering ( ) [inline, static]

Definition at line 124 of file SoShapeHintsElement.h.

virtual void SoShapeHintsElement::init ( SoState state) [virtual]

Reimplemented from SoElement.

Reimplemented in SoGLShapeHintsElement.

static void SoShapeHintsElement::initClass ( ) [static]

Reimplemented from SoElement.

Reimplemented in SoGLShapeHintsElement.

static SbBool SoShapeHintsElement::isVBOUsed ( SoState state) [static]
virtual SbBool SoShapeHintsElement::matches ( const SoElement elt) const [virtual]

Implements SoElement.

virtual void SoShapeHintsElement::print ( FILE *  fp) const [virtual]

Reimplemented from SoElement.

virtual void SoShapeHintsElement::push ( SoState state) [virtual]

Reimplemented from SoElement.

Reimplemented in SoGLShapeHintsElement.

static void SoShapeHintsElement::set ( SoState state,
VertexOrdering  vertexOrdering,
ShapeType  shapeType,
FaceType  faceType 
) [static]

Calls virtual method that subclasses can override.

static void SoShapeHintsElement::set ( SoState state,
SbBool  useVBO 
) [static]
static void SoShapeHintsElement::set ( SoState state,
SoNode ,
VertexOrdering  vertexOrdering,
ShapeType  shapeType,
FaceType  faceType 
) [inline, static]

Definition at line 110 of file SoShapeHintsElement.h.

virtual void SoShapeHintsElement::setElt ( VertexOrdering  vertexOrdering,
ShapeType  shapeType,
FaceType  faceType 
) [protected, virtual]

Reimplemented in SoGLShapeHintsElement.


Member Data Documentation

Definition at line 153 of file SoShapeHintsElement.h.

Definition at line 152 of file SoShapeHintsElement.h.

Definition at line 154 of file SoShapeHintsElement.h.


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