EntityInstance.h

Go to the documentation of this file.

/*
Copyright 2007-2025. 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.
*/
 
#ifndef AGXDATA_ENTITYINSTANCE_H
#define AGXDATA_ENTITYINSTANCE_H
 
#include <agx/agx.h>
#include <agx/hash.h>
// #include <agxData/EntityData.h>
 
namespace agxData
{
  class EntityStorage;
  class EntityData;
  class EntityModel;
  class EntityPtr;
  typedef agxData::EntityData* EntityDataPtr;
 
 
  class AGXCORE_EXPORT EntityInstance
  {
  public:
    EntityInstance();
    EntityInstance(agxData::EntityStorage* storage, agx::Index index);
    EntityInstance(agxData::EntityData* data, agx::Index index);
    EntityInstance(const agxData::EntityInstance& other);
    EntityInstance(const agxData::EntityPtr& other);
 
    ~EntityInstance() = default;
 
    void init(agxData::EntityData* data, agx::Index index);
 
    agx::Index getIndex() const;
 
    agx::Index calculateId() const;
 
    agxData::EntityData* getData();
    const agxData::EntityData* getData() const;
 
    agxData::EntityStorage* getStorage();
    const agxData::EntityStorage* getStorage() const;
 
    agxData::EntityModel* getModel();
    const agxData::EntityModel* getModel() const;
 
    bool isInstanceOf(agxData::EntityModel* model) const;
 
    bool isValid() const;
 
    void verifyIndex() const;
 
 
    // Hash function
    agx::UInt32 hash() const;
 
    bool operator!() const;
    operator bool() const;
 
    bool operator<( const EntityInstance& rhs ) const;
    bool operator>( const EntityInstance& rhs ) const;
 
    bool operator==( const EntityInstance& rhs ) const;
    bool operator!=( const EntityInstance& rhs ) const;
 
    static void TransformToAscii(void *targetBuffer, const void *sourceBuffer, size_t numElements);
 
  private:
 
    EntityDataPtr m_data;
    agx::Index m_index;
  };
 
 
  AGXCORE_EXPORT std::ostream& operator << (std::ostream& output, const EntityInstance& entity);
 
  /* Implementation */
  AGX_FORCE_INLINE EntityInstance::EntityInstance() : m_data(nullptr), m_index(agx::InvalidIndex)
  {}
 
  AGX_FORCE_INLINE EntityInstance::EntityInstance(agxData::EntityData* data, agx::Index index) : m_data(data), m_index(index)
  {}
 
 
  AGX_FORCE_INLINE EntityInstance::EntityInstance(const agxData::EntityInstance& other) : m_data(other.m_data), m_index(other.m_index)
  {}
 
 
  AGX_FORCE_INLINE void EntityInstance::init(agxData::EntityData* data, agx::Index index) { m_data = data; m_index = index; }
 
  AGX_FORCE_INLINE agx::Index EntityInstance::getIndex() const { return m_index; }
 
  AGX_FORCE_INLINE agxData::EntityData* EntityInstance::getData() { return m_data; }
  AGX_FORCE_INLINE const agxData::EntityData* EntityInstance::getData() const { return m_data; }
 
  AGX_FORCE_INLINE agx::UInt32 EntityInstance::hash() const
  {
    return agx::hash( agx::hash( m_data ), agx::hash( m_index ) );
  }
 
  AGX_FORCE_INLINE bool EntityInstance::isValid() const { return m_data != nullptr; }
  AGX_FORCE_INLINE bool EntityInstance::operator!() const { return !this->isValid(); }
  AGX_FORCE_INLINE EntityInstance::operator bool() const { return this->isValid(); }
 
  AGX_FORCE_INLINE bool EntityInstance::operator<( const EntityInstance& rhs ) const
  {
    return this->getIndex() < rhs.getIndex();
  }
 
  AGX_FORCE_INLINE bool EntityInstance::operator>( const EntityInstance& rhs ) const
  {
    return this->getIndex() > rhs.getIndex();
  }
 
  AGX_FORCE_INLINE bool EntityInstance::operator==( const EntityInstance& rhs ) const
  {
    return (this->getStorage() == rhs.getStorage()) && (this->getIndex() == rhs.getIndex());
  }
 
  AGX_FORCE_INLINE bool EntityInstance::operator!=( const EntityInstance& rhs ) const
  {
    return (this->getStorage() != rhs.getStorage()) || (this->getIndex() != rhs.getIndex());
  }
 
 
}
 
 
#endif /* AGXDATA_ENTITYINSTANCE_H */