OpenSceneGraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::LOD Class Reference

LOD - Level Of Detail group node which allows switching between children depending on distance from eye point. More...

Inheritance diagram for osg::LOD:
Inheritance graph
[legend]

Public Types

enum  CenterMode { USE_BOUNDING_SPHERE_CENTER, USER_DEFINED_CENTER, UNION_OF_BOUNDING_SPHERE_AND_USER_DEFINED }
 Modes which control how the center of object should be determined when computing which child is active. More...
 
enum  RangeMode { DISTANCE_FROM_EYE_POINT, PIXEL_SIZE_ON_SCREEN }
 Modes that control how the range values should be interpreted when computing which child is active. More...
 
typedef osg::BoundingSphere::vec_type vec_type
 
typedef osg::BoundingSphere::value_type value_type
 
typedef std::pair< float, float > MinMaxPair
 
typedef std::vector< MinMaxPairRangeList
 
- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
 A vector of osg::Group pointers which is used to store the parent(s) of node. More...
 
typedef unsigned int NodeMask
 This is a set of bits (flags) that represent the Node. More...
 
typedef std::vector< std::string > DescriptionList
 A vector of std::string's which are used to describe the object. More...
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 LOD ()
 Default constructor The default constructor sets. More...
 
 LOD (const LOD &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
 META_Node (osg, LOD)
 
virtual void traverse (NodeVisitor &nv)
 Traverse downwards : calls children's accept method with NodeVisitor. More...
 
virtual bool addChild (Node *child)
 Add Node to Group. More...
 
virtual bool addChild (Node *child, float rmin, float rmax)
 
template<class T >
bool addChild (const ref_ptr< T > &child, float rmin, float rmax)
 
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove=1)
 Remove children from Group. More...
 
void setCenterMode (CenterMode mode)
 Set how the center of object should be determined when computing which child is active. More...
 
CenterMode getCenterMode () const
 Get how the center of object should be determined when computing which child is active. More...
 
void setCenter (const vec_type &center)
 Sets the object-space point which defines the center of the osg::LOD. More...
 
const vec_typegetCenter () const
 return the LOD center point. More...
 
void setRadius (value_type radius)
 Set the object-space reference radius of the volume enclosed by the LOD. More...
 
value_type getRadius () const
 Get the object-space radius of the volume enclosed by the LOD. More...
 
void setRangeMode (RangeMode mode)
 Set how the range values should be interpreted when computing which child is active. More...
 
RangeMode getRangeMode () const
 Get how the range values should be interpreted when computing which child is active. More...
 
void setRange (unsigned int childNo, float min, float max)
 Sets the min and max visible ranges of range of specific child. More...
 
float getMinRange (unsigned int childNo) const
 returns the min visible range for specified child. More...
 
float getMaxRange (unsigned int childNo) const
 returns the max visible range for specified child. More...
 
unsigned int getNumRanges () const
 returns the number of ranges currently set. More...
 
void setRangeList (const RangeList &rangeList)
 set the list of MinMax ranges for each child. More...
 
const RangeListgetRangeList () const
 return the list of MinMax ranges for each child. More...
 
virtual BoundingSphere computeBound () const
 Compute the bounding sphere around Node's geometry or children. More...
 
- Public Member Functions inherited from osg::Group
 Group ()
 
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
 META_Node (osg, Group)
 
virtual GroupasGroup ()
 convert 'this' into a Group pointer if Node is a Group, otherwise return 0. More...
 
virtual const GroupasGroup () const
 convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0. More...
 
template<class T >
bool addChild (const ref_ptr< T > &child)
 
virtual bool insertChild (unsigned int index, Node *child)
 Insert Node to Group at specific location. More...
 
template<class T >
bool insertChild (unsigned int index, const ref_ptr< T > &child)
 
virtual bool removeChild (Node *child)
 Remove Node from Group. More...
 
template<class T >
bool removeChild (const ref_ptr< T > &child)
 
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
 Remove Node from Group. More...
 
virtual bool replaceChild (Node *origChild, Node *newChild)
 Replace specified child Node with another Node. More...
 
template<class T , class R >
bool replaceChild (const ref_ptr< T > &origChild, const ref_ptr< R > &newChild)
 
virtual unsigned int getNumChildren () const
 Return the number of children nodes. More...
 
virtual bool setChild (unsigned int i, Node *node)
 Set child node at position i. More...
 
NodegetChild (unsigned int i)
 Return child node at position i. More...
 
const NodegetChild (unsigned int i) const
 Return child node at position i. More...
 
bool containsNode (const Node *node) const
 Return true if node is contained within Group. More...
 
template<class T >
bool containsNode (const ref_ptr< T > &node) const
 
unsigned int getChildIndex (const Node *node) const
 Get the index number of child, return a value between 0 and _children.size()-1 if found, if not found then return _children.size(). More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
- Public Member Functions inherited from osg::Node
 Node ()
 Construct a node. More...
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
virtual ObjectcloneType () const
 clone an object of the same type as the node. More...
 
virtual Objectclone (const CopyOp &copyop) const
 return a clone of a node, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *obj) const
 return true if this and obj are of the same kind of object. More...
 
virtual const char * libraryName () const
 return the name of the node's library. More...
 
virtual const char * className () const
 return the name of the node's class type. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 convert 'this' into a Drawable pointer if Node is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Node is a Drawable, otherwise return 0. More...
 
virtual GeometryasGeometry ()
 convert 'this' into a Geometry pointer if Node is a Geometry, otherwise return 0. More...
 
virtual const GeometryasGeometry () const
 convert 'const this' into a const Geometry pointer if Node is a Geometry, otherwise return 0. More...
 
virtual TransformasTransform ()
 Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. More...
 
virtual const TransformasTransform () const
 convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0. More...
 
virtual OccluderNodeasOccluderNode ()
 Convert 'this' into an OccluderNode pointer if Node is an OccluderNode, otherwise return 0. More...
 
virtual const OccluderNodeasOccluderNode () const
 Convert 'const this' into a const OccluderNode pointer if Node is an OccluderNode, otherwise return 0. More...
 
virtual SwitchasSwitch ()
 Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0. More...
 
virtual const SwitchasSwitch () const
 convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0. More...
 
virtual GeodeasGeode ()
 Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0. More...
 
virtual const GeodeasGeode () const
 convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0. More...
 
virtual osgTerrain::TerrainasTerrain ()
 Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0. More...
 
virtual const osgTerrain::TerrainasTerrain () const
 convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0. More...
 
virtual void accept (NodeVisitor &nv)
 Visitor Pattern : calls the apply method of a NodeVisitor with this node's type. More...
 
virtual void ascend (NodeVisitor &nv)
 Traverse upwards : calls parents' accept method with NodeVisitor. More...
 
const ParentListgetParents () const
 Get the parent list of node. More...
 
ParentList getParents ()
 Get the a copy of parent list of node. More...
 
GroupgetParent (unsigned int i)
 
const GroupgetParent (unsigned int i) const
 Get a single const parent of node. More...
 
unsigned int getNumParents () const
 Get the number of parents of node. More...
 
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 Get the list of node paths parent paths. More...
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates. More...
 
void setUpdateCallback (Callback *nc)
 Set update node callback, called during update traversal. More...
 
template<class T >
void setUpdateCallback (const ref_ptr< T > &nc)
 
CallbackgetUpdateCallback ()
 Get update node callback, called during update traversal. More...
 
const CallbackgetUpdateCallback () const
 Get const update node callback, called during update traversal. More...
 
void addUpdateCallback (Callback *nc)
 Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one. More...
 
template<class T >
void addUpdateCallback (const ref_ptr< T > &nc)
 
void removeUpdateCallback (Callback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested. More...
 
template<class T >
void removeUpdateCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children. More...
 
void setEventCallback (Callback *nc)
 Set event node callback, called during event traversal. More...
 
template<class T >
void setEventCallback (const ref_ptr< T > &nc)
 
CallbackgetEventCallback ()
 Get event node callback, called during event traversal. More...
 
const CallbackgetEventCallback () const
 Get const event node callback, called during event traversal. More...
 
void addEventCallback (Callback *nc)
 Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one. More...
 
template<class T >
void addEventCallback (const ref_ptr< T > &nc)
 
void removeEventCallback (Callback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested. More...
 
template<class T >
void removeEventCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children. More...
 
void setCullCallback (Callback *nc)
 Set cull node callback, called during cull traversal. More...
 
template<class T >
void setCullCallback (const ref_ptr< T > &nc)
 
CallbackgetCullCallback ()
 Get cull node callback, called during cull traversal. More...
 
const CallbackgetCullCallback () const
 Get const cull node callback, called during cull traversal. More...
 
void addCullCallback (Callback *nc)
 Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one. More...
 
template<class T >
void addCullCallback (const ref_ptr< T > &nc)
 
void removeCullCallback (Callback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested. More...
 
template<class T >
void removeCullCallback (const ref_ptr< T > &nc)
 
void setCullingActive (bool active)
 Set the view frustum/small feature culling of this node to be active or inactive. More...
 
bool getCullingActive () const
 Get the view frustum/small feature _cullingActive flag for this node. More...
 
unsigned int getNumChildrenWithCullingDisabled () const
 Get the number of Children of this node which have culling disabled. More...
 
bool isCullingActive () const
 Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal. More...
 
unsigned int getNumChildrenWithOccluderNodes () const
 Get the number of Children of this node which are or have OccluderNode's. More...
 
bool containsOccluderNodes () const
 return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes. More...
 
void setNodeMask (NodeMask nm)
 Set the node mask. More...
 
NodeMask getNodeMask () const
 Get the node Mask. More...
 
void setStateSet (osg::StateSet *stateset)
 Set the node's StateSet. More...
 
template<class T >
void setStateSet (const osg::ref_ptr< T > &stateset)
 
osg::StateSetgetOrCreateStateSet ()
 return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet. More...
 
osg::StateSetgetStateSet ()
 Return the node's StateSet. More...
 
const osg::StateSetgetStateSet () const
 Return the node's const StateSet. More...
 
void setDescriptions (const DescriptionList &descriptions)
 Set the list of string descriptions. More...
 
DescriptionListgetDescriptions ()
 Get the description list of the node. More...
 
const DescriptionListgetDescriptions () const
 Get the const description list of the const node. More...
 
const std::string & getDescription (unsigned int i) const
 Get a single const description of the const node. More...
 
std::string & getDescription (unsigned int i)
 Get a single description of the node. More...
 
unsigned int getNumDescriptions () const
 Get the number of descriptions of the node. More...
 
void addDescription (const std::string &desc)
 Add a description string to the node. More...
 
void setInitialBound (const osg::BoundingSphere &bsphere)
 Set the initial bounding volume to use when computing the overall bounding volume. More...
 
const BoundingSpheregetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume. More...
 
void dirtyBound ()
 Mark this node's bounding sphere dirty. More...
 
const BoundingSpheregetBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 Set the compute bound callback to override the default computeBound. More...
 
template<class T >
void setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 Get the compute bound callback. More...
 
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 Get the const compute bound callback. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual Uniform * asUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const Uniform * asUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Member Functions

virtual ~LOD ()
 
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
 
virtual void childRemoved (unsigned int, unsigned int)
 
virtual void childInserted (unsigned int)
 
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 Node destructor. More...
 
void addParent (osg::Group *parent)
 
void removeParent (osg::Group *parent)
 
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
 
void setNumChildrenRequiringEventTraversal (unsigned int num)
 
void setNumChildrenWithCullingDisabled (unsigned int num)
 
void setNumChildrenWithOccluderNodes (unsigned int num)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

CenterMode _centerMode
 
vec_type _userDefinedCenter
 
value_type _radius
 
RangeMode _rangeMode
 
RangeList _rangeList
 
- Protected Attributes inherited from osg::Group
NodeList _children
 
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
 
ref_ptr< ComputeBoundingSphereCallback_computeBoundCallback
 
BoundingSphere _boundingSphere
 
bool _boundingSphereComputed
 
ParentList _parents
 
ref_ptr< Callback_updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< Callback_eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< Callback_cullCallback
 
bool _cullingActive
 
unsigned int _numChildrenWithCullingDisabled
 
unsigned int _numChildrenWithOccluderNodes
 
NodeMask _nodeMask
 
ref_ptr< StateSet_stateset
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Detailed Description

LOD - Level Of Detail group node which allows switching between children depending on distance from eye point.

Typical uses are for load balancing - objects further away from the eye point are rendered at a lower level of detail, and at times of high stress on the graphics pipeline lower levels of detail can also be chosen by adjusting the viewers's Camera/CullSettings LODScale value. Each child has a corresponding valid range consisting of a minimum and maximum distance. Given a distance to the viewer (d), LOD displays a child if min <= d < max. LOD may display multiple children simultaneously if their corresponding ranges overlap. Children can be in any order, and don't need to be sorted by range or amount of detail. If the number of ranges (m) is less than the number of children (n), then children m+1 through n are ignored.

Member Typedef Documentation

◆ MinMaxPair

typedef std::pair<float,float> osg::LOD::MinMaxPair

◆ RangeList

typedef std::vector<MinMaxPair> osg::LOD::RangeList

◆ value_type

◆ vec_type

Member Enumeration Documentation

◆ CenterMode

Modes which control how the center of object should be determined when computing which child is active.

Furthermore it determines how the bounding sphere is calculated.

Enumerator
USE_BOUNDING_SPHERE_CENTER 

Uses the bounding sphere's center as the center of object and the geometrical bounding sphere of the node's children.

USER_DEFINED_CENTER 

Uses the user defined center as the center of object; the bounding sphere is determined by the user defined center and user defined radius.

UNION_OF_BOUNDING_SPHERE_AND_USER_DEFINED 

Uses the user defined center as the center of object; the bounding sphere is the user defined bounding sphere expanded by the geometrical bounding sphere of the node's children.

◆ RangeMode

Modes that control how the range values should be interpreted when computing which child is active.

Enumerator
DISTANCE_FROM_EYE_POINT 
PIXEL_SIZE_ON_SCREEN 

Constructor & Destructor Documentation

◆ LOD() [1/2]

osg::LOD::LOD ( )

Default constructor The default constructor sets.

  • the center mode to USE_BOUNDING_SPHERE,
  • the radius to a value smaller than zero and
  • the range mode to DISTANCE_FROM_EYE_POINT.

◆ LOD() [2/2]

osg::LOD::LOD ( const LOD ,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

◆ ~LOD()

virtual osg::LOD::~LOD ( )
inlineprotectedvirtual

Member Function Documentation

◆ addChild() [1/3]

virtual bool osg::LOD::addChild ( Node child)
virtual

Add Node to Group.

If node is not NULL then increment its reference count, add it to the child list and dirty the bounding sphere to force it to recompute on next getBound() and return true for success. Otherwise return false. Scene nodes can't be added as child nodes.

Reimplemented from osg::Group.

Reimplemented in osg::PagedLOD.

◆ addChild() [2/3]

virtual bool osg::LOD::addChild ( Node child,
float  rmin,
float  rmax 
)
virtual

Reimplemented in osg::PagedLOD.

◆ addChild() [3/3]

template<class T >
bool osg::LOD::addChild ( const ref_ptr< T > &  child,
float  rmin,
float  rmax 
)
inline

References addChild(), and osg::ref_ptr< T >::get().

Referenced by addChild().

◆ computeBound()

virtual BoundingSphere osg::LOD::computeBound ( ) const
virtual

Compute the bounding sphere around Node's geometry or children.

This method is automatically called by getBound() when the bounding sphere has been marked dirty via dirtyBound().

Reimplemented from osg::Group.

Reimplemented in osgSim::Impostor.

◆ getCenter()

const vec_type& osg::LOD::getCenter ( ) const
inline

return the LOD center point.

◆ getCenterMode()

CenterMode osg::LOD::getCenterMode ( ) const
inline

Get how the center of object should be determined when computing which child is active.

◆ getMaxRange()

float osg::LOD::getMaxRange ( unsigned int  childNo) const
inline

returns the max visible range for specified child.

◆ getMinRange()

float osg::LOD::getMinRange ( unsigned int  childNo) const
inline

returns the min visible range for specified child.

◆ getNumRanges()

unsigned int osg::LOD::getNumRanges ( ) const
inline

returns the number of ranges currently set.

An LOD which has been fully set up will have getNumChildren()==getNumRanges().

◆ getRadius()

value_type osg::LOD::getRadius ( ) const
inline

Get the object-space radius of the volume enclosed by the LOD.

◆ getRangeList()

const RangeList& osg::LOD::getRangeList ( ) const
inline

return the list of MinMax ranges for each child.

◆ getRangeMode()

RangeMode osg::LOD::getRangeMode ( ) const
inline

Get how the range values should be interpreted when computing which child is active.

◆ META_Node()

osg::LOD::META_Node ( osg  ,
LOD   
)

◆ removeChildren()

virtual bool osg::LOD::removeChildren ( unsigned int  pos,
unsigned int  numChildrenToRemove = 1 
)
virtual

Remove children from Group.

Note, must be override by subclasses of Group which add per child attributes.

Reimplemented from osg::Group.

Reimplemented in osg::PagedLOD.

◆ setCenter()

void osg::LOD::setCenter ( const vec_type center)
inline

Sets the object-space point which defines the center of the osg::LOD.

center is affected by any transforms in the hierarchy above the osg::LOD.

Note
This method also changes the center mode to USER_DEFINED_CENTER if the current center mode does not use a user defined center!
See also
setRadius

◆ setCenterMode()

void osg::LOD::setCenterMode ( CenterMode  mode)
inline

Set how the center of object should be determined when computing which child is active.

◆ setRadius()

void osg::LOD::setRadius ( value_type  radius)
inline

Set the object-space reference radius of the volume enclosed by the LOD.

Parameters
radiusRadius must be larger or equal to zero. If the radius is smaller than zero the geometrical bounding sphere of the node's children is used as the LOD's bounding sphere regardless of the center mode setting.
Remarks
The radius is only used to calculate the bounding sphere.
See also
setCenter

◆ setRange()

void osg::LOD::setRange ( unsigned int  childNo,
float  min,
float  max 
)

Sets the min and max visible ranges of range of specific child.

Values are floating point distance specified in local objects coordinates.

◆ setRangeList()

void osg::LOD::setRangeList ( const RangeList rangeList)
inline

set the list of MinMax ranges for each child.

◆ setRangeMode()

void osg::LOD::setRangeMode ( RangeMode  mode)
inline

Set how the range values should be interpreted when computing which child is active.

◆ traverse()

virtual void osg::LOD::traverse ( NodeVisitor )
virtual

Traverse downwards : calls children's accept method with NodeVisitor.

Reimplemented from osg::Group.

Reimplemented in osgSim::Impostor, and osg::PagedLOD.

Member Data Documentation

◆ _centerMode

CenterMode osg::LOD::_centerMode
protected

◆ _radius

value_type osg::LOD::_radius
protected

◆ _rangeList

RangeList osg::LOD::_rangeList
protected

◆ _rangeMode

RangeMode osg::LOD::_rangeMode
protected

◆ _userDefinedCenter

vec_type osg::LOD::_userDefinedCenter
protected

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