vtkboneConstraint.h

Go to the documentation of this file.

/*=========================================================================

  Copyright 2010-2016, Numerics88 Solutions Ltd.
  http://www.numerics88.com/

  Copyright (c) Eric Nodwell and Steven K. Boyd
  See Copyright.txt for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
=========================================================================*/

#ifndef __vtkboneConstraint_h
#define __vtkboneConstraint_h

#include "vtkObject.h"
#include "vtkIdTypeArray.h"
#include "vtkboneWin32Header.h"

// Forward declarations
class vtkIdTypeArray;
class vtkDataSetAttributes;
class vtkDataArray;

class VTKBONE_EXPORT vtkboneConstraint : public vtkObject
{
public:
  static vtkboneConstraint* New();
  vtkTypeMacro(vtkboneConstraint, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  void Initialize();

  enum ConstraintAppliedTo_t {
    NODES,
    ELEMENTS,
    NUMBER_OF_ConstraintAppliedTo
  };

  enum ConstraintType_t {
    FORCE,
    DISPLACEMENT,
    NUMBER_OF_ConstraintType
  };

  enum ConstraintSense_t {
    SENSE_X = 0,
    SENSE_Y = 1,
    SENSE_Z = 2
  };

  enum Distribution_t {
    FACE_X0_DISTRIBUTION,
    FACE_X1_DISTRIBUTION,
    FACE_Y0_DISTRIBUTION,
    FACE_Y1_DISTRIBUTION,
    FACE_Z0_DISTRIBUTION,
    FACE_Z1_DISTRIBUTION,
    BODY_DISTRIBUTION,
    NUMBER_OF_Distribution
  };

  static const char* GetConstraintAppliedToAsString(int ConstraintAppliedTo);

  static const char* GetConstraintTypeAsString(int ConstraintType);

  static const char* GetDistributionAsString(int Distribution);


  vtkSetStringMacro(Name);
  vtkGetStringMacro(Name);


  vtkSetObjectMacro(Indices, vtkIdTypeArray);
  vtkGetObjectMacro(Indices, vtkIdTypeArray);

  unsigned long int GetMTime();


  vtkSetClampMacro(ConstraintAppliedTo,
                   int, 0, NUMBER_OF_ConstraintAppliedTo);
  vtkGetMacro(ConstraintAppliedTo, int);


  vtkSetClampMacro(ConstraintType,
                   int, 0, NUMBER_OF_ConstraintType);
  vtkGetMacro(ConstraintType, int);


  virtual vtkIdType GetNumberOfValues()
      {return this->GetIndices()->GetNumberOfTuples();}


  virtual void RemoveValue(vtkIdType id);
  virtual void RemoveLastValue();

  vtkDataSetAttributes *GetAttributes() {return this->Attributes;};

  virtual int CheckAttributes();

  virtual int Merge(vtkboneConstraint* other);


  virtual void ShallowCopy(vtkboneConstraint *constraint);
  virtual void DeepCopy(vtkboneConstraint *constraint);

protected:
  vtkboneConstraint();
  ~vtkboneConstraint();

  char* Name;
  vtkIdTypeArray* Indices;    // node or element set
  vtkDataSetAttributes* Attributes;   // Scalars, vectors, etc. associated w/ each point

  int ConstraintAppliedTo;
  int ConstraintType;

private:
  vtkboneConstraint(const vtkboneConstraint&);  // Not implemented.
  void operator=(const vtkboneConstraint&);  // Not implemented.
};

#endif