vsg 1.1.10
VulkanSceneGraph library
Loading...
Searching...
No Matches
vsg::DepthSorted Class Reference

#include <DepthSorted.h>

Inheritance diagram for vsg::DepthSorted:
Collaboration diagram for vsg::DepthSorted:

Public Member Functions

 DepthSorted (const DepthSorted &rhs, const CopyOp &copyop={})
 DepthSorted (int32_t in_binNumber, const dsphere &in_bound, ref_ptr< Node > in_child)
ref_ptr< Objectclone (const CopyOp &copyop={}) 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 traverse (Visitor &visitor) override
void traverse (ConstVisitor &visitor) const override
void traverse (RecordTraversal &visitor) const override
void read (Input &input) override
void write (Output &output) const override
Public Member Functions inherited from vsg::Inherit< Node, DepthSorted >
 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
Public Member Functions inherited from vsg::Node
 Node (const Node &rhs, const CopyOp &copyop={})
ref_ptr< Objectclone (const CopyOp &copyop={}) const override
Public Member Functions inherited from vsg::Inherit< Object, Node >
 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
Public Member Functions inherited from vsg::Object
 Object (const Object &object, const CopyOp &copyop={})
Objectoperator= (const Object &)
template<class T>
T * cast ()
template<class T>
const T * cast () const
virtual void accept (ConstVisitor &visitor) const
virtual void accept (RecordTraversal &visitor) 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

Public Attributes

int32_t binNumber = 0
dsphere bound
ref_ptr< Nodechild

Additional Inherited Members

Static Public Member Functions inherited from vsg::Inherit< Node, DepthSorted >
static ref_ptr< DepthSortedcreate (Args &&... args)
static ref_ptr< DepthSortedcreate_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)
Protected Member Functions inherited from vsg::Object
virtual void _attemptDelete () const
void setAuxiliary (Auxiliary *auxiliary)

Detailed Description

DepthSorted node is used to control which bin to place the subgraph in. During the RecordTraversal the node's bound sphere is tested against the view frustum and if within, the subgraph is traversed, with the children being in specified bin. Typically used for decorating translucent objects that should be sorted back to front to ensure correct blending.

Member Function Documentation

◆ clone()

ref_ptr< Object > vsg::DepthSorted::clone ( const CopyOp & copyop = {}) const
inlineoverridevirtual

clone this object using CopyOp's duplicates map to decide whether to clone or to return the original object. The default clone(CopyOp&) implementation simply returns ref_ptr<> to this object rather attempt to clone.

Reimplemented from vsg::Object.

◆ compare()

int vsg::DepthSorted::compare ( const Object & rhs) const
overridevirtual

compare two objects, return -1 if this object is less than rhs, return 0 if it's equal, return 1 if rhs is greater,

Reimplemented from vsg::Object.

◆ read()

void vsg::DepthSorted::read ( Input & input)
overridevirtual

Reimplemented from vsg::Object.

◆ traverse() [1/3]

void vsg::DepthSorted::traverse ( ConstVisitor & visitor) const
inlineoverridevirtual

Reimplemented from vsg::Object.

◆ traverse() [2/3]

void vsg::DepthSorted::traverse ( RecordTraversal & visitor) const
inlineoverridevirtual

Reimplemented from vsg::Object.

◆ traverse() [3/3]

void vsg::DepthSorted::traverse ( Visitor & visitor)
inlineoverridevirtual

Reimplemented from vsg::Object.

◆ write()

void vsg::DepthSorted::write ( Output & output) const
overridevirtual

Reimplemented from vsg::Object.


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