vsg  1.1.0
VulkanSceneGraph library
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
vsg::PagedLOD Class Reference

#include <PagedLOD.h>

Inheritance diagram for vsg::PagedLOD:
Inheritance graph
[legend]
Collaboration diagram for vsg::PagedLOD:
Collaboration graph
[legend]

Classes

struct  Child
 

Public Types

enum  RequestStatus : unsigned int {
  NoRequest = 0 , ReadRequest = 1 , Reading = 2 , Compiling = 3 ,
  MergeRequest = 4 , Merging = 5 , DeleteRequest = 6 , Deleting = 7
}
 
using Children = std::array< Child, 2 >
 

Public Member Functions

void traverse (Visitor &visitor) override
 
void traverse (ConstVisitor &visitor) const override
 
void traverse (RecordTraversal &visitor) const override
 
int compare (const Object &rhs) const override
 compare two objects, return -1 if this object is less than rhs, return 0 if it's equal, return 1 if rhs is greater,
 
void read (Input &input) override
 
void write (Output &output) const override
 
bool highResActive (uint64_t frameCount, uint64_t inactiveAge=3) const
 
- Public Member Functions inherited from vsg::Inherit< Node, PagedLOD >
 Inherit (Args &&... args)
 
std::size_t sizeofObject () const noexcept override
 
const char * className () const noexcept override
 
const std::type_info & type_info () const noexcept override
 
bool is_compatible (const std::type_info &type) const noexcept override
 
int compare (const Object &rhs) const override
 
void accept (Visitor &visitor) override
 
void accept (ConstVisitor &visitor) const override
 
void accept (RecordTraversal &visitor) const override
 
- Public Member Functions inherited from vsg::Inherit< Object, Node >
 Inherit (Args &&... args)
 
- Public Member Functions inherited from vsg::Object
 Object (const Object &)
 
Objectoperator= (const Object &)
 
template<class T >
T * cast ()
 
template<class T >
const T * cast () const
 
void ref () const noexcept
 
void unref () const noexcept
 
void unref_nodelete () const noexcept
 
unsigned int referenceCount () const noexcept
 
template<typename T >
void setValue (const std::string &key, const T &value)
 
void setValue (const std::string &key, const char *value)
 specialization of setValue to handle passing C strings
 
template<typename T >
bool getValue (const std::string &key, T &value) const
 get specified value type, return false if value associated with key is not assigned or is not the correct type
 
void setObject (const std::string &key, ref_ptr< Object > object)
 assign an Object associated with key
 
ObjectgetObject (const std::string &key)
 get Object pointer associated with key, return nullptr if no object associated with key has been assigned
 
const ObjectgetObject (const std::string &key) const
 get const Object pointer associated with key, return nullptr if no object associated with key has been assigned
 
template<class T >
T * getObject (const std::string &key)
 get object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
 
template<class T >
const T * getObject (const std::string &key) const
 get const object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
 
ref_ptr< ObjectgetRefObject (const std::string &key)
 get ref_ptr<Object> associated with key, return nullptr if no object associated with key has been assigned
 
ref_ptr< const ObjectgetRefObject (const std::string &key) const
 get ref_ptr<const Object> pointer associated with key, return nullptr if no object associated with key has been assigned
 
template<class T >
ref_ptr< T > getRefObject (const std::string &key)
 get ref_ptr<T> of specified type associated with key, return nullptr if no object associated with key has been assigned
 
template<class T >
const ref_ptr< const T > getRefObject (const std::string &key) const
 get ref_ptr<const T> of specified type associated with key, return nullptr if no object associated with key has been assigned
 
void removeObject (const std::string &key)
 remove meta object or value associated with key
 
AuxiliarygetOrCreateAuxiliary ()
 
AuxiliarygetAuxiliary ()
 
const AuxiliarygetAuxiliary () const
 

Static Public Member Functions

template<class N , class V >
static void t_traverse (N &node, V &visitor)
 
- Static Public Member Functions inherited from vsg::Inherit< Node, PagedLOD >
static ref_ptr< PagedLODcreate (Args &&... args)
 
static ref_ptr< PagedLODcreate_if (bool flag, Args &&... args)
 
- Static Public Member Functions inherited from vsg::Node
static void * operator new (std::size_t count)
 provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_NODES_OBJECTS
 
static void operator delete (void *ptr)
 
- Static Public Member Functions inherited from vsg::Inherit< Object, Node >
static ref_ptr< Nodecreate (Args &&... args)
 
static ref_ptr< Nodecreate_if (bool flag, Args &&... args)
 
- Static Public Member Functions inherited from vsg::Object
static ref_ptr< Objectcreate ()
 
static ref_ptr< Objectcreate_if (bool flag)
 
static void * operator new (std::size_t count)
 provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_AFFINTY_OBJECTS
 
static void operator delete (void *ptr)
 

Public Attributes

Path filename
 
dsphere bound
 
Children children
 
ref_ptr< Optionsoptions
 
std::atomic< double > priority {0.0}
 
std::atomic_uint64_t frameHighResLastUsed {0}
 
std::atomic_uint requestCount {0}
 
std::atomic< RequestStatus > requestStatus {NoRequest}
 
uint32_t index = 0
 
ref_ptr< Nodepending
 

Additional Inherited Members

- Protected Member Functions inherited from vsg::Object
virtual void _attemptDelete () const
 
void setAuxiliary (Auxiliary *auxiliary)
 

Detailed Description

Level of Detail Node, Children should be ordered with the highest resolution PagedLODChild first, through to lowest resolution PagedLODChild last. The PagedLODChild struct stores the minimumScreenHeightRatio and child that it's associated with. During culling the minimumScreenHeightRatio is used as a minimum ratio of screen height that a bounding sphere needs to occupy in order for the associated child to be traversed. Once one child passes this test no more children are checked, so that no more than one child will ever be traversed in a record traversal. If no PagedLODChild passes the visible height test then none of the PagedLOD's children will be visible. During the record traversals the Bound sphere is also checked against the view frustum so that PagedLOD's also enable view frustum culling for subgraphs so there is no need for a separate CullNode/CullGroup to decorate it.


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