RigidBodyRenderCache.h

Go to the documentation of this file.

/*
Copyright 2007-2024. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
 
#pragma once
 
#include <agxOSG/export.h>
#include <agx/Math.h>
#include <agx/Referenced.h>
#include <agx/RigidBody.h>
#include <agxOSG/GeometryNode.h>
 
 
namespace agxOSG
{
  AGX_DECLARE_POINTER_TYPES(RigidBodyRenderCache);
  class AGXOSG_EXPORT RigidBodyRenderCache : public agx::Referenced
  {
  public:
    AGX_DECLARE_POINTER_TYPES(RigidBodyVisualGroup);
    class RigidBodyVisualGroup : public agx::Referenced
    {
      public:
 
        RigidBodyVisualGroup() :
          m_group(nullptr) { }
 
        RigidBodyVisualGroup(osg::Group* group, std::vector<size_t> geometryIndex) :
          m_group(group), m_geometryIndices(geometryIndex) { }
 
        agxCollide::GeometryRef getGeometry(agx::RigidBody* newBody, size_t visualIndex) const;
 
        bool isValid() const { return m_group != nullptr; }
 
        size_t getNumChildren() const { return isValid() ? m_group->getNumChildren() : 0; }
 
        osg::Group* getGroup() const { return m_group; }
 
      private:
        osg::ref_ptr<osg::Group> m_group;
        // a list with indices linking each visual node (child in m_group) to a geometry in the rigid body
        std::vector<size_t> m_geometryIndices;
    };
 
  public:
    RigidBodyRenderCache(bool onlyAddEmittedBodies=true);
 
    void addToCache(osg::Group* rootNode);
 
    osg::Group* getNode(agx::RigidBody* body);
 
    bool getOnlyAddEmittedBodies() const;
 
    void setOnlyAddEmittedBodies( bool enable );
 
    const RigidBodyRenderCache::RigidBodyVisualGroup& addTemplateBodyToVisualCache( agx::RigidBody* body );
 
    const RigidBodyRenderCache::RigidBodyVisualGroup& getCachedTemplateBodyVisual( agx::RigidBody* body );
 
    const RigidBodyRenderCache::RigidBodyVisualGroup& getOrCreateCachedTemplateBodyNode( agx::RigidBody* body );
 
    bool bodyIsTemplateEmitted( agx::RigidBody* body );
 
    void clear();
 
  protected:
    virtual ~RigidBodyRenderCache();
    void traverseAndInsert(osg::Group* rootNode);
    bool shouldAddBody(agx::RigidBody* body) const;
 
  private:
    typedef agx::HashTable<agx::RigidBody*, osg::Group*> BodyToGroupNodeTable;
    typedef agx::HashTable<agx::String, RigidBodyRenderCache::RigidBodyVisualGroupRef> BodyToRenderGroupTable;
 
    BodyToGroupNodeTable   m_bodiesToGroupNodes;
    BodyToRenderGroupTable m_bodiesToRenderGroups;
    bool                   m_onlyAddEmittedBodies;
    // A placeholder for an empty visualization group
    RigidBodyRenderCache::RigidBodyVisualGroup m_emptyGroup;
  };
}