![]() |
http://www.sim.no http://www.coin3d.org |
#include <Inventor/VRMLnodes/SoVRMLLOD.h>
Inheritance diagram for SoVRMLLOD:
The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:
LOD { exposedField MFNode level [] field SFVec3f center 0 0 0 # (-,) field MFFloat range [] # (0,) }
The LOD node specifies various levels of detail or complexity for a given object, and provides hints allowing browsers to automatically choose the appropriate version of the object based on the distance from the user. The level field contains a list of nodes that represent the same object or objects at varying levels of detail, ordered from highest level of detail to the lowest level of detail. The range field specifies the ideal distances at which to switch between the levels. Subclause 4.6.5, Grouping and children nodes (<http://www.web3d.org/technicalinfo/specifications/vrml97/part1/concepts.html#4.6.5>), contains details on the types of nodes that are legal values for level.
The center field is a translation offset in the local coordinate system that specifies the centre of the LOD node for distance calculations.
The number of nodes in the level field shall exceed the number of values in the range field by one (i.e., N+1 level values for N range values). The range field contains monotonic increasing values that shall be greater than zero. In order to calculate which level to display, first the distance is calculated from the viewer's location, transformed into the local coordinate system of the LOD node (including any scaling transformations), to the center point of the LOD node. Then, the LOD node evaluates the step function L(d) to choose a level for a given value of d (where d is the distance from the viewer position to the centre of the LOD node). Let n ranges, R0, R1, R2, ..., Rn-1, partition the domain (0, +infinity) into n+1 subintervals given by (0, R0), [R0, R1)... , [Rn-1, +infinity). Also, let n levels L0, L1, L2, ..., Ln-1 be the values of the step function function L(d). The level node, L(d), for a given distance d is defined as follows:
L(d) = L0, if d < R0, = Li+1, if Ri <= d < Ri+1, for -1 < i < n-1, = Ln-1, if d >= Rn-1.
Specifying too few levels will result in the last level being used repeatedly for the lowest levels of detail. If more levels than ranges are specified, the extra levels are ignored. An empty range field is an exception to this rule. This case is a hint to the browser that it may choose a level automatically to maintain a constant display rate. Each value in the range field shall be greater than the previous value.
LOD nodes are evaluated top-down in the scene graph. Only the descendants of the currently selected level are rendered. All nodes under an LOD node continue to receive and send events regardless of which LOD node's level is active. For example, if an active TimeSensor node is contained within an inactive level of an LOD node, the TimeSensor node sends events regardless of the LOD node's state.
Public Member Functions | |
virtual SoType | getTypeId (void) const |
SoVRMLLOD (void) | |
SoVRMLLOD (int levels) | |
virtual SbBool | affectsState (void) const |
void | addLevel (SoNode *level) |
void | insertLevel (SoNode *level, int idx) |
SoNode * | getLevel (int idx) const |
int | findLevel (const SoNode *level) const |
int | getNumLevels (void) const |
void | removeLevel (int idx) |
void | removeLevel (SoNode *level) |
void | removeAllLevels (void) |
void | replaceLevel (int idx, SoNode *level) |
void | replaceLevel (SoNode *old, SoNode *level) |
virtual void | doAction (SoAction *action) |
virtual void | callback (SoCallbackAction *action) |
virtual void | GLRender (SoGLRenderAction *action) |
virtual void | rayPick (SoRayPickAction *action) |
virtual void | getBoundingBox (SoGetBoundingBoxAction *action) |
virtual void | search (SoSearchAction *action) |
virtual void | write (SoWriteAction *action) |
virtual void | getPrimitiveCount (SoGetPrimitiveCountAction *action) |
virtual void | audioRender (SoAudioRenderAction *action) |
virtual void | GLRenderBelowPath (SoGLRenderAction *action) |
virtual void | GLRenderInPath (SoGLRenderAction *action) |
virtual void | GLRenderOffPath (SoGLRenderAction *action) |
void | addChild (SoNode *child) |
void | insertChild (SoNode *child, int idx) |
SoNode * | getChild (int idx) const |
int | findChild (const SoNode *child) const |
int | getNumChildren (void) const |
void | removeChild (int idx) |
void | removeChild (SoNode *child) |
void | removeAllChildren (void) |
void | replaceChild (int idx, SoNode *child) |
void | replaceChild (SoNode *old, SoNode *child) |
virtual SoChildList * | getChildren (void) const |
Static Public Member Functions | |
SoType | getClassTypeId (void) |
void | initClass (void) |
Public Attributes | |
SoMFFloat | range |
SoSFVec3f | center |
SoMFNode | level |
Protected Member Functions | |
virtual const SoFieldData * | getFieldData (void) const |
virtual | ~SoVRMLLOD () |
virtual void | notify (SoNotList *list) |
virtual SbBool | readInstance (SoInput *in, unsigned short flags) |
virtual void | copyContents (const SoFieldContainer *from, SbBool copyConn) |
virtual int | whichToTraverse (SoAction *action) |
Static Protected Member Functions | |
const SoFieldData ** | getFieldDataPtr (void) |
Friends | |
class | SoVRMLLODP |
|
Constructor. |
|
Constructor. levels is the expected number of levels. |
|
Destructor. |
|
This static method returns the SoType object associated with objects of this class. Reimplemented from SoGroup. |
|
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. Usage example:
For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. Reimplemented from SoGroup. |
|
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Reimplemented from SoGroup. |
|
Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns Reimplemented from SoGroup. |
|
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Reimplemented from SoGroup. |
|
Returns
If it returns
The default method returns Reimplemented from SoNode. |
|
Adds a new level. |
|
Inserts a new level. |
|
Returns a level. |
|
Find node, and return the level index or -1 if not found. |
|
Return the number of levels. |
|
Removes the level at index idx. |
|
Find level, and remove it if found. |
|
Remove all levels. |
|
Replace the level at idx with node. |
|
Find oldnode, and replace it with newnode. |
|
This function performs the typical operation of a node for any action. Reimplemented from SoGroup. |
|
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 SoGroup. |
|
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 SoGroup. |
|
Action method for SoRayPickAction. Checks the ray specification of the action and tests for intersection with the data of the node. Nodes influencing relevant state variables for how picking is done also overrides this method. Reimplemented from SoNode. |
|
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 SoGroup. |
|
Action method for SoSearchAction. Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction -- if any of the requested criteria is a miss, the search is not deemed successful for the node.
Reimplemented from SoGroup. |
|
Action method for SoWriteAction. Writes out a node object, and any connected nodes, engines etc, if necessary. Reimplemented from SoGroup. |
|
Action method for the SoGetPrimitiveCountAction. Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables. Reimplemented from SoGroup. |
|
Action method for SoAudioRenderAction. Does common processing for SoAudioRenderAction action instances. Reimplemented from SoGroup. |
|
Implements the SoAction::BELOW_PATH traversal method for the rendering action. Reimplemented from SoNode. |
|
Implements the SoAction::IN_PATH traversal method for the rendering action. Reimplemented from SoNode. |
|
Implements the SoAction::OFF_PATH traversal method for the rendering action. Reimplemented from SoNode. |
|
Append a child node to the list of children nodes this group node is managing. Please note that this method is not virtual in the original SGI Inventor API. Reimplemented from SoGroup. |
|
Insert a child node at position newchildindex. Please note that this method is not virtual in the original SGI Inventor API. Reimplemented from SoGroup. |
|
Returns pointer to child node at index. Please note that this method is not virtual in the original SGI Inventor API. Reimplemented from SoGroup. |
|
Returns index in our list of children for child node, or -1 if node is not a child of this group node. Please note that this method is not virtual in the original SGI Inventor API. Reimplemented from SoGroup. |
|
Returns number of child nodes managed by this group. Please note that this method is not virtual in the original SGI Inventor API. Reimplemented from SoGroup. |
|
Remove node at childindex in our list of children. Please note that this method is not virtual in the original SGI Inventor API. Reimplemented from SoGroup. |
|
Remove child from the set of children managed by this group node. Will decrease the reference count of child by 1. This is a convenience method. It will simply call findChild() with child as argument, and then call removeChild(int) if the child is found. Please note that this method is not virtual in the original SGI Inventor API. Reimplemented from SoGroup. |
|
Do not manage the children anymore. Will dereference all children by 1 as they are removed. Please note that this method is not virtual in the original SGI Inventor API. Reimplemented from SoGroup. |
|
Replace child at index with newChild. Dereferences the child previously at index, and increases the reference count of newChild by 1. Please note that this method is not virtual in the original SGI Inventor API. Reimplemented from SoGroup. |
|
Replace oldchild with newchild. Dereferences oldchild by 1, and increases the reference count of newchild by 1. This is a convenience method. It will simply call findChild() with oldchild as argument, and call replaceChild(int, SoNode*) if the child is found. Please note that this method is not virtual in the original SGI Inventor API. Reimplemented from SoGroup. |
|
Returns list of children. Reimplemented from SoGroup. |
|
Notifies all auditors for this instance when changes are made. Reimplemented from SoNode. |
|
This method is mainly intended for internal use during file import operations. It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.
flags is used internally during binary import when reading user extension nodes, group nodes or engines. Reimplemented from SoGroup. |
|
Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically. Note that for simply copying e.g. a node from application code, it should be sufficient to do:
Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:
Reimplemented from SoGroup. |
|
Returns the child to traverse based on distance to current viewpoint. |
|
The range for each level. |
|
The center used when calculating distance. |
|
The different levels. |
Copyright © 1998-2004 by Systems in Motion AS. All rights reserved.
Generated on Tue Jul 13 06:58:06 2004 for Coin by Doxygen. 1.3.6