gmSpatialIndex.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2015 by Erwan Yann Renaut
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE.
**
************************************************************************/

#ifndef _GEMA_SPATIAL_INDEX_H_
#define _GEMA_SPATIAL_INDEX_H_

#include "gmPluginObject.h"
#include "gmPluginCategory.h"

#include "gmVector.h"

class GmMesh;
class GmCell;
class GmValueAccessor;

class GMC_API_EXPORT GmSpatialIndex : public GmPluginObject
{
public:
  GmSpatialIndex(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~GmSpatialIndex();

  // Comments on the base class
  virtual const char* pluginCategory() const { return GM_PLUGIN_SPATIALINDEX; }

  virtual bool hasCapability(QString capabilityName) const = 0;

  virtual GmMesh* mesh() const = 0;

  virtual const GmValueAccessor* coordAccessor() const = 0;

  virtual bool activeOnly() const = 0;

  virtual int ruleSet() const = 0;

  virtual bool isOutsideOfDomain(const GmVector& crd) const = 0;

  virtual int numReferences() const = 0;

  virtual int getClosestNode(const GmVector& crd, double& sqrDist) const = 0;

  virtual void getClosestNodes(const GmVector& crd, int n, QList<int>& nodeList, QList<double>& sdList) const = 0;

  virtual void getClosestNodes(const GmVector& crd, double r, QList<int>& nodeList, QList<double>& sdList) const = 0;

  virtual GmCell* getContainingCell(const GmVector& crd) const = 0;

  virtual QPair<int, int> getClosestGaussPoint(const GmVector& crd, double& sqrDist) const = 0;

  virtual void getClosestGaussPoints(const GmVector& crd, int n, QList< QPair<int, int> >& gpList, QList<double>& sdList) const = 0;

  virtual void getClosestGaussPoints(const GmVector& crd, double r, QList< QPair<int, int> >& gpList, QList<double>& sdList) const = 0;

  virtual void printParameters(const GmLogCategory& logger);
};


#endif // _GEMA_SPATIAL_INDEX_H_