Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoPointSet Class Reference

Point set shape node. More...

#include <Inventor/nodes/SoPointSet.h>

+ Inheritance diagram for SoPointSet:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoPointSet ()
 Creates a point set node with default settings.
 
- Public Member Functions inherited from SoVertexShape
SoNormalCache * getNormalCache () const
 Returns the current normal cache, or NULL if there is none.
 
SoTangentCache * getTangentCache () const
 Returns the current tangent cache, or NULL if there is none.
 
- Public Member Functions inherited from SoShape
virtual SbBool affectsState () const
 Overrides default method on SoNode.
 
ShapeType getShapeType ()
 Gets the current shape Full Scene Antialiasing type.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNonIndexedShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoVertexShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SbBool isPrimitiveRestartAvailable (SoState *state=NULL)
 Returns TRUE if the primitive restart feature is available.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFInt32 numPoints
 Number of points.
 
- Public Attributes inherited from SoNonIndexedShape
SoSFInt32 startIndex
 Index of first coordinate of shape.
 
- Public Attributes inherited from SoVertexShape
SoSFNode vertexProperty
 vertex property node.
 
- Public Attributes inherited from SoShape
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Additional Inherited Members

- Public Types inherited from SoShape
enum  ShapeType {
  POINTS ,
  LINES ,
  POLYGONS ,
  TEXT
}
 Basic type for antialiased rendering for this shape (Do not consider the SoDrawStyle property currently in the state). More...
 

Detailed Description

Point set shape node.

This node represents a set of points located at the coordinates specified by the vertexProperty field (from SoVertexShape) or the current inherited coordinates. For optimal performance, the vertexProperty field is recommended.

SoPointSet uses the coordinates in order, starting with the coordinate at startIndex. The number of coordinates to use (the number of points in the set) is specified by the numPoints field. The default value of this field is -1, which means to use all the coordinates, so it may not be necessary to explicitly set this field.

The coordinates of the point set are transformed by the current cumulative transformation.

Lighting is not applied to points (i.e., they are rendered with light model BASE_COLOR) unless the application explicitly sets normal vectors using SoVertexProperty or SoNormal. Note that this is specific to direct rendering of point sets. If you render polygonal geometry, e.g. SoFaceSet, in POINTS mode (SoDrawStyle), normal vectors are computed by Open Inventor and lighting is enabled.

NOTE: If you want to apply lighting in a shader, you still need to explicitly set normal vectors, otherwise lighting will be disabled for the point set.

Point size is controlled by the SoDrawStyle field pointSize.

Automatic simplification (by skipping points) is controlled by the SoComplexity field value. Only values < 0.5 have any effect.

Treatment of the current material and normal binding is as follows: PER_PART, PER_FACE, and PER_VERTEX bindings bind one material or normal to each point. The default material binding is OVERALL. The default normal binding is PER_VERTEX.

Shape Antialiasing type is SoShape::POINTS.

Limitations:

  • By default, SoPointSet ignores the vertex ordering set on the state by SoShapeHints nodes in order to avoid a performance hit on some GeForce cards. However, this default behavior can be changed using the environment variable OIV_POINT_SET_USE_VERTEX_ORDERING (see SoPreferences).

FILE FORMAT/DEFAULT

    PointSet {
    vertexProperty NULL
    startIndex 0
    numPoints -1
    }

ACTION BEHAVIOR

    SoGLRenderAction
    Draws points based on the current coordinates, normals, materials, drawing style, and so on.

    SoRayPickAction
    Picks points based on the current coordinates and transformation. Details about the intersection are returned in an SoPointDetail.

    SoGetBoundingBoxAction
    Computes the bounding box that encloses all points in the set with the current transformation applied to them. Sets the center to the average of the coordinates of all points.

    SoCallbackAction
    If any point callbacks are registered with the action, they will be invoked for each point in the set.

SEE ALSO

SoCoordinate3, SoDrawStyle, SoFullSceneAntialiasing, SoIndexedPointSet, SoPointDetail, SoVertexProperty

Definition at line 162 of file SoPointSet.h.

Constructor & Destructor Documentation

◆ SoPointSet()

SoPointSet::SoPointSet ( )

Creates a point set node with default settings.

Member Function Documentation

◆ getClassTypeId()

static SoType SoPointSet::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoPointSet::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNonIndexedShape.

Reimplemented in SoMarkerSet.

Member Data Documentation

◆ numPoints

SoSFInt32 SoPointSet::numPoints

Number of points.

Definition at line 171 of file SoPointSet.h.


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