IAddInfoLayout.hpp

#pragma once
 
#include "DM/config.hpp"
#include "DM/ColumnTypes.hpp"
#include "DM/Handle.hpp"
#include "DM/ObjectBase.hpp"
#include "DM/AutoLink.hpp" //enable autolink
 
 
DM_NAMESPACE_BEGIN
 
/// \brief AddInfo layouts describe a set of attributes that can be attached to geometry objects
/**
  Managing attributes, layout and views is a core feature of the DM library. Please refer to the
  \ref dm_attributes section for implementation concepts and to the <a href="examples.html">examples</a>
  section (attribute handling) for further details.
*/
class DM_API IAddInfoLayout : public ObjectBase
{
public:
  /// returns the predefined column name for a specific semantic.
  static const char*  getColumnName(ColumnSemantic semantic);
  /// returns the column type  of a predefined semantic
  static ColumnType getColumnType(ColumnSemantic semantic);
 
  /// find the semantic enumerator based on a given column name
  /// \return corresponding enumerator of ColumnSemantic::null if the given name isn't a predefined colum name
  static ColumnSemantic getColumnSemantic(const char* name, bool caseSensitive = true);
  /// find the type of a predefined column based on a given column name
  /// \return corresponding enumerator of ColumnType::count if the given name isn't a predefined colum name
  static ColumnType     getColumnType(const char* name, bool caseSensitive = true);
 
  /// return from a IAddInfoLayout pointer the corresponding handle object (AddInfoLayoutHandle)
  static StaticHandle<IAddInfoLayout> getHandle(const IAddInfoLayout *obj);
 
protected:
  virtual ~IAddInfoLayout() {}
 
public:
  virtual unsigned columns() const = 0;
 
  virtual const char*       name(unsigned index) const = 0;
  virtual ColumnType      type(unsigned index) const = 0;
  virtual ColumnSemantic  semantic(unsigned index) const = 0;
  virtual unsigned          size(unsigned index) const = 0;     ///< returns array size
 
  virtual int index(const char*) const = 0;
  virtual int index(ColumnSemantic) const = 0;
};
 
bool equal(const IAddInfoLayout &l1, const IAddInfoLayout &l2);  ///< check if the 'viewed' content of two layouts is the same
 
typedef StaticHandle<IAddInfoLayout> AddInfoLayoutHandle;
 
DM_NAMESPACE_END