Loading...
Searching...
No Matches
vsg::InstanceNode Class Reference
#include <InstanceNode.h>
Inheritance diagram for vsg::InstanceNode:
Collaboration diagram for vsg::InstanceNode:
Public Member Functions | |
| InstanceNode (const InstanceNode &rhs, const CopyOp ©op={}) | |
| void | setTranslations (vsg::ref_ptr< vec3Array > data) |
| vsg::ref_ptr< vec3Array > | getTranslations () |
| const vsg::ref_ptr< vec3Array > | getTranslations () const |
| void | setRotations (vsg::ref_ptr< quatArray > data) |
| vsg::ref_ptr< quatArray > | getRotations () |
| const vsg::ref_ptr< quatArray > | getRotations () const |
| void | setScales (vsg::ref_ptr< vec3Array > data) |
| vsg::ref_ptr< vec3Array > | getScales () |
| const vsg::ref_ptr< vec3Array > | getScales () const |
| void | setColors (vsg::ref_ptr< vec3Array > data) |
| vsg::ref_ptr< vec3Array > | getColors () |
| const vsg::ref_ptr< vec3Array > | getColors () const |
| ref_ptr< Object > | clone (const CopyOp ©op={}) 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 |
| void | compile (Context &context) override |
| Public Member Functions inherited from vsg::Inherit< Compilable, InstanceNode > | |
| 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 |
| void | accept (Visitor &visitor) override |
| Public Member Functions inherited from vsg::Compilable | |
| Compilable (const Compilable &rhs, const CopyOp ©op={}) | |
| Public Member Functions inherited from vsg::Inherit< Node, Compilable > | |
| 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 |
| void | accept (Visitor &visitor) override |
| Public Member Functions inherited from vsg::Node | |
| Node (const Node &rhs, const CopyOp ©op={}) | |
| ref_ptr< Object > | clone (const CopyOp ©op={}) 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 |
| void | accept (Visitor &visitor) override |
| Public Member Functions inherited from vsg::Object | |
| Object (const Object &object, const CopyOp ©op={}) | |
| Object & | operator= (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 | |
| Object * | getObject (const std::string &key) |
| get Object pointer associated with key, return nullptr if no object associated with key has been assigned | |
| const Object * | getObject (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< Object > | getRefObject (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 Object > | getRefObject (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 | |
| Auxiliary * | getOrCreateAuxiliary () |
| Auxiliary * | getAuxiliary () |
| const Auxiliary * | getAuxiliary () const |
Public Attributes | |
| uint32_t | firstInstance = 0 |
| uint32_t | instanceCount = 0 |
| vsg::ref_ptr< BufferInfo > | translations |
| vsg::ref_ptr< BufferInfo > | rotations |
| vsg::ref_ptr< BufferInfo > | scales |
| vsg::ref_ptr< BufferInfo > | colors |
| ref_ptr< vsg::Node > | child |
Additional Inherited Members | |
| Static Public Member Functions inherited from vsg::Inherit< Compilable, InstanceNode > | |
| static ref_ptr< InstanceNode > | create (Args &&... args) |
| static ref_ptr< InstanceNode > | create_if (bool flag, Args &&... args) |
| Static Public Member Functions inherited from vsg::Inherit< Node, Compilable > | |
| static ref_ptr< Compilable > | create (Args &&... args) |
| static ref_ptr< Compilable > | create_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< Node > | create (Args &&... args) |
| static ref_ptr< Node > | create_if (bool flag, Args &&... args) |
| Static Public Member Functions inherited from vsg::Object | |
| static ref_ptr< Object > | create () |
| static ref_ptr< Object > | create_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
InstanceNode provides a mechanism for specifying the translations, rotations and scales (transform arrays) of subgraph that contains InstanceDraw leaf node(s) that utlize the InstanceNode's per instance transform arrays combined with the InstanceDraw nodes per vertex arrays.
InstanceNode only work correctly when the child subgraphs that obey these contraints:
- Do not contain any Transform nodes
- Do not contain any Culling nodes
- Do not contain any InstanceNode nodes
- Do not contain any standard vsg::Geometry/VertexDraw/VertexIndexDraw leaf nodes, only InstanceDraw leaf nodes.
Member Function Documentation
◆ clone()
|
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()
|
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::Inherit< Compilable, InstanceNode >.
◆ compile()
|
overridevirtual |
Reimplemented from vsg::Compilable.
◆ read()
|
overridevirtual |
Reimplemented from vsg::Object.
◆ traverse() [1/3]
|
inlineoverridevirtual |
Reimplemented from vsg::Object.
◆ traverse() [2/3]
|
inlineoverridevirtual |
Reimplemented from vsg::Object.
◆ traverse() [3/3]
|
inlineoverridevirtual |
Reimplemented from vsg::Object.
◆ write()
|
overridevirtual |
Reimplemented from vsg::Object.
The documentation for this class was generated from the following file:
- include/vsg/nodes/InstanceNode.h
