Linux Certif

Toute la documentation sur la certification Linux LPI

SoDrawStyle.3coin2

NAME

SoDrawStyle -

The SoDrawStyle class specificies common rendering properties for shapes.

Use SoDrawStyle nodes to influence how shape nodes following them in the scenegraph will be rendered. This node type have fields to help decide how certain aspects of point-based shapes, line-based shapes and filled shape primitives are rendered.

SYNOPSIS

#include <Inventor/nodes/SoDrawStyle.h>

Inherits SoNode.

Public Types

enum Style { FILLED = SoDrawStyleElement::FILLED, LINES = SoDrawStyleElement::LINES, POINTS = SoDrawStyleElement::POINTS, INVISIBLE = SoDrawStyleElement::INVISIBLE }

Public Member Functions

SoDrawStyle (void)

virtual void doAction (SoAction *action)

virtual void GLRender (SoGLRenderAction *action)

virtual void callback (SoCallbackAction *action)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFEnum style

SoSFFloat pointSize

SoSFFloat lineWidth

SoSFUShort linePattern

Protected Member Functions

virtual ~SoDrawStyle ()

Detailed Description

The SoDrawStyle class specificies common rendering properties for shapes.

Use SoDrawStyle nodes to influence how shape nodes following them in the scenegraph will be rendered. This node type have fields to help decide how certain aspects of point-based shapes, line-based shapes and filled shape primitives are rendered.

Simple scenegraph structure usage example:

   #Inventor V2.1 ascii
   
   Separator {
      Sphere { }
      Translation { translation 4 0 0 }
      DrawStyle { style LINES  lineWidth 2 }
      Sphere { }
      Translation { translation 4 0 0 }
      DrawStyle { style POINTS  pointSize 2 }
      Sphere { }
   }
 

  

FILE FORMAT/DEFAULTS:

     DrawStyle {
         style FILLED
         pointSize 0
         lineWidth 0
         linePattern 0xffff
     }
 
 

 

Member Enumeration Documentation

enum SoDrawStyle::StyleEnumeration for the various ways to render geometry.

Enumerator:

FILLED

Render all geometry as-is.

LINES

Render all geometry as border lines.

POINTS

Render all geometry as vertex points.

INVISIBLE

Don't render geometry.

Constructor & Destructor Documentation

SoDrawStyle::SoDrawStyle (void)Constructor.

References FILLED, INVISIBLE, linePattern, LINES, lineWidth, POINTS, pointSize, and style.

SoDrawStyle::~SoDrawStyle () [protected, virtual]Destructor.

Member Function Documentation

void SoDrawStyle::initClass (void) [static]Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoNode.

void SoDrawStyle::doAction (SoAction * action) [virtual]This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

References SoAction::getState(), SoField::isIgnored(), SoNode::isOverride(), linePattern, lineWidth, pointSize, SoFieldContainer::set(), SoOverrideElement::setDrawStyleOverride(), SoOverrideElement::setLinePatternOverride(), SoOverrideElement::setLineWidthOverride(), SoOverrideElement::setPointSizeOverride(), and style.

Referenced by callback(), and GLRender().

void SoDrawStyle::GLRender (SoGLRenderAction * action) [virtual]Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

References doAction().

void SoDrawStyle::callback (SoCallbackAction * action) [virtual]Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoNode.

References doAction().

Member Data Documentation

SoSFEnum SoDrawStyle::styleHow to render the geometry following a drawstyle node in the scene graph. Default SoDrawStyle::FILLED.

Referenced by doAction(), and SoDrawStyle().

SoSFFloat SoDrawStyle::pointSizeSize in screen pixels of SoPointSet points, and also of geometry vertex points if setting the SoDrawStyle::style to SoDrawStyle::POINTS.

The valid range of pointsize settings varies according to which OpenGL implementation is used. For the purpose of not trying to set illegal values, the application programmer should at run-time check the valid range. How this can be accomplished is described in the class documentation of SoGLPointSizeElement.

Default value is 0.0f, which is a 'tag' value which tells the rendering library to use the default setting.

Referenced by doAction(), and SoDrawStyle().

SoSFFloat SoDrawStyle::lineWidthWidth in screen pixels of SoLineSet and SoIndexedLineSet lines, and also of geometry border lines if setting the SoDrawStyle::style to SoDrawStyle::LINES.

The valid range of linewidth settings varies according to which OpenGL implementation is used. For the purpose of not trying to set illegal values, the application programmer should at run-time check the valid range. How this can be accomplished is described in the class documentation of SoGLLineWidthElement.

Default value is 0.0f, which is a 'tag' value which tells the rendering library to use the default setting.

Referenced by doAction(), and SoDrawStyle().

SoSFUShort SoDrawStyle::linePatternPattern as a bitmask used when drawing lines. Default is 0xffff (no 'holes').

Referenced by doAction(), and SoDrawStyle().

Author

Generated automatically by Doxygen for Coin from the source code.