Coin Logo http://www.sim.no/
http://www.coin3d.org/

SoCacheHint Class Reference
[Node Classes]

The SoCacheHint class is a node containing hints about how to cache geometry.The SoCacheHint node is used to set up clues to the rendering subsystem about how Coin should cache vertex data. More...

#include <Inventor/nodes/SoCacheHint.h>

Inheritance diagram for SoCacheHint:
SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

 SoCacheHint (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void pick (SoPickAction *action)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFFloat memValue
SoSFFloat gfxValue

Protected Member Functions

virtual ~SoCacheHint ()

Detailed Description

The SoCacheHint class is a node containing hints about how to cache geometry.

The SoCacheHint node is used to set up clues to the rendering subsystem about how Coin should cache vertex data.

Please note that this is an experimental class. The API might change a lot before/if it's included in any official Coin release.

FILE FORMAT/DEFAULTS:

    CacheHint {
        memValue 0.5
        gfxValue 0.5
    }

Constructor & Destructor Documentation

SoCacheHint::SoCacheHint ( void   ) 

Constructor.

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

Destructor.


Member Function Documentation

void SoCacheHint::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 SoCacheHint::doAction ( SoAction action  )  [virtual]

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

void SoCacheHint::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.

void SoCacheHint::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.

void SoCacheHint::getBoundingBox ( SoGetBoundingBoxAction action  )  [virtual]

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

void SoCacheHint::pick ( SoPickAction action  )  [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.


Member Data Documentation

Sets the value for main memory usage. Should be a number between 0 and 1. A higher value will use more memory for caching. Default value is 0.5

Sets the value for gfx memory usage. Should be a number between 0 and 1. A higher value will use more memory for caching. Default value is 0.5


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

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated on 7 Jan 2016 for Coin by Doxygen 1.6.1.