Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoFullSceneAntialiasing Class Reference

VSG extension Node that controls full-scene antialiasing. More...

#include <Inventor/nodes/SoFullSceneAntialiasing.h>

+ Inheritance diagram for SoFullSceneAntialiasing:

Public Types

enum  Filter {
  POINTS = SoFullSceneAntialiasingElement::POINTS ,
  LINES = SoFullSceneAntialiasingElement::LINES ,
  POLYGONS = SoFullSceneAntialiasingElement::POLYGONS ,
  TEXT = SoFullSceneAntialiasingElement::TEXT ,
  ALL = SoFullSceneAntialiasingElement::ALL
}
 Defines the types of rendering shapes. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoFullSceneAntialiasing ()
 Constructor.
 
virtual void setOverride (const SbBool state)
 Set the state of the override field.
 
virtual SbBool isOverride () const
 Returns the state of the override field.
 
- Public Member Functions inherited from SoNode
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
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 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

SoSFBool on
 Enables/disables full-scene antialiasing.
 
SoSFBitMask filter
 A bit-wise combination of LINES, POINTS, POLYGONS, and TEXT that determines which primitive types should be antialiased.
 

Detailed Description

VSG extension Node that controls full-scene antialiasing.

This class controls full-scene antialiasing. This node can be used to enable or disable the antialiasing mode on a part of a scene graph.

This node has no effect if full-scene antialiasing is not supported in the graphics hardware or has not been enabled. Full-scene antialiasing can be enabled by defining a graphic configuration template, by calling the setAntialiasing() method in SoSceneManager and some viewer classes, or (on some systems) by the user through the system display properties dialog.

The filter field allows you to select what kind of nodes (derived from SoShape) will be antialiased. For certain primitives antialiasing may be undesirable. For example, bitmap text (SoText2, etc.) may be "blurred" by antialiasing.

The filter result is highly dependent on your graphics hardware.

Note: The quality level specified by the setAntialiasing() method cannot be changed during a traversal because it depends on the pixel format.

FILE FORMAT/DEFAULT

    FullSceneAntialiasing {
    on TRUE
    filter ALL
    }

ACTION BEHAVIOR

SEE ALSO

SoGLGraphicConfigTemplate, SoWinGLWidget::setAntialiasing()

Definition at line 73 of file SoFullSceneAntialiasing.h.

Member Enumeration Documentation

◆ Filter

Defines the types of rendering shapes.

Enumerator
POINTS 

The shape is render based on points (Ex: SoPointSet).

LINES 

The shape is render based on lines (Ex: SoLineSet).

POLYGONS 

The shape is render based on polygons (Ex: SoFaceSet).

TEXT 

The shape is a text and follows the special filter for texts.

ALL 

No specific filter for antialiasing (Default).

Definition at line 89 of file SoFullSceneAntialiasing.h.

Constructor & Destructor Documentation

◆ SoFullSceneAntialiasing()

SoFullSceneAntialiasing::SoFullSceneAntialiasing ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoFullSceneAntialiasing::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoFullSceneAntialiasing::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

◆ isOverride()

virtual SbBool SoFullSceneAntialiasing::isOverride ( ) const
inlinevirtual

Returns the state of the override field.

Reimplemented from SoNode.

Definition at line 134 of file SoFullSceneAntialiasing.h.

◆ setOverride()

virtual void SoFullSceneAntialiasing::setOverride ( const SbBool  state)
inlinevirtual

Set the state of the override field.

see SoNode::setOverride doc.

Reimplemented from SoNode.

Definition at line 128 of file SoFullSceneAntialiasing.h.

Member Data Documentation

◆ filter

SoSFBitMask SoFullSceneAntialiasing::filter

A bit-wise combination of LINES, POINTS, POLYGONS, and TEXT that determines which primitive types should be antialiased.



Default = ALL. The default value can be set using the environment variable OIV_FULL_SCENE_ANTIALIASING_FILTER. Valid values are ALL, or any combination of LINES, POINTS, POLYGONS, and TEXT.

The rules to determine if the antialiasing extension should stay enabled or should be disabled are described in the following tables:

ShapeFilterTable
Shape Type
Draw Style
Filter
Enable AA
POLYGON FILLED LINES
POINTS
POLYGONS
TEXT
ALL


X

X
LINES LINES
POINTS
POLYGONS
TEXT
ALL
X



X
POINTS LINES
POINTS
POLYGONS
TEXT
ALL

X


X
INVISIBLE
-
 
Shape Type
Draw Style
Filter
Enable AA
TEXT FILLED LINES
POINTS
POLYGONS
TEXT
ALL


X
X
X
LINES LINES
POINTS
POLYGONS
TEXT
ALL
X


X
X
POINTS LINES
POINTS
POLYGONS
TEXT
ALL

X

X
X
INVISIBLE
-
 
All text are antialiased when the SoFullSceneAntialiasing filter is set to TEXT Otherwise, the AA is made considering the draw style element state.
Shape Type
Draw Style
Filter
Enable AA
LINE FILLED
LINES
LINES
POINTS
POLYGONS
TEXT
ALL
X



X
POINTS LINES
POINTS
POLYGONS
TEXT
ALL

X


X
INVISIBLE
-
 
Shape Type
Draw Style
Filter
Enable AA
POINT FILLED
LINES
POINTS
LINES
POINTS
POLYGONS
TEXT
ALL

X


X
INVISIBLE
-
 

 

Definition at line 117 of file SoFullSceneAntialiasing.h.

◆ on

SoSFBool SoFullSceneAntialiasing::on

Enables/disables full-scene antialiasing.



Default = TRUE. The default value can be set using the environment variable OIV_FULL_SCENE_ANTIALIASING (0 = FALSE, 1 = TRUE).

Definition at line 84 of file SoFullSceneAntialiasing.h.


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