vtkProp3D.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkProp3D_h
#define vtkProp3D_h

#include "vtkNew.h" // for ivar
#include "vtkProp.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWeakPointer.h"         // For vtkWeakPointer
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkLinearTransform;
class vtkMatrix4x4;
class vtkRenderer;
class vtkTransform;

class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkProp3D : public vtkProp
{
public:
  vtkTypeMacro(vtkProp3D, vtkProp);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void ShallowCopy(vtkProp* prop) override;


  virtual void SetPosition(double x, double y, double z)
  {
    vtkDebugMacro(<< this->GetClassName() << " (" << this << "): setting Position to (" << x << ","
                  << y << "," << z << ")");
    if ((this->Position[0] != x) || (this->Position[1] != y) || (this->Position[2] != z))
    {
      this->Position[0] = x;
      this->Position[1] = y;
      this->Position[2] = z;
      this->Modified();
      this->IsIdentity = 0;
    }
  }

  virtual void SetPosition(double pos[3]) { this->SetPosition(pos[0], pos[1], pos[2]); }
  vtkGetVectorMacro(Position, double, 3);
  void AddPosition(double deltaPosition[3]);
  void AddPosition(double deltaX, double deltaY, double deltaZ);


  virtual void SetOrigin(double x, double y, double z)
  {
    vtkDebugMacro(<< this->GetClassName() << " (" << this << "): setting Origin to (" << x << ","
                  << y << "," << z << ")");
    if ((this->Origin[0] != x) || (this->Origin[1] != y) || (this->Origin[2] != z))
    {
      this->Origin[0] = x;
      this->Origin[1] = y;
      this->Origin[2] = z;
      this->Modified();
      this->IsIdentity = 0;
    }
  }
  virtual void SetOrigin(const double pos[3]) { this->SetOrigin(pos[0], pos[1], pos[2]); }
  vtkGetVectorMacro(Origin, double, 3);


  virtual void SetScale(double x, double y, double z)
  {
    vtkDebugMacro(<< this->GetClassName() << " (" << this << "): setting Scale to (" << x << ","
                  << y << "," << z << ")");
    if (this->Scale[0] != x || this->Scale[1] != y || this->Scale[2] != z)
    {
      this->Scale[0] = x;
      this->Scale[1] = y;
      this->Scale[2] = z;
      this->Modified();
      this->IsIdentity = 0;
    }
  }
  virtual void SetScale(double scale[3]) { this->SetScale(scale[0], scale[1], scale[2]); }
  vtkGetVectorMacro(Scale, double, 3);

  void SetScale(double s) { this->SetScale(s, s, s); }


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  void SetUserTransform(vtkLinearTransform* transform);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  vtkGetObjectMacro(UserTransform, vtkLinearTransform);


  void SetUserMatrix(vtkMatrix4x4* matrix);
  vtkMatrix4x4* GetUserMatrix();


  virtual void GetMatrix(vtkMatrix4x4* result);
  virtual void GetMatrix(double result[16]);


  virtual void GetModelToWorldMatrix(vtkMatrix4x4* result);

  virtual void SetPropertiesFromModelToWorldMatrix(vtkMatrix4x4* modelToWorld);


  void GetBounds(double bounds[6]);
  double* GetBounds() VTK_SIZEHINT(6) override = 0;

  double* GetCenter() VTK_SIZEHINT(3);

  double* GetXRange() VTK_SIZEHINT(2);

  double* GetYRange() VTK_SIZEHINT(2);

  double* GetZRange() VTK_SIZEHINT(2);

  double GetLength();

  void RotateX(double);

  void RotateY(double);

  void RotateZ(double);

  void RotateWXYZ(double w, double x, double y, double z);

  void SetOrientation(double x, double y, double z);

  void SetOrientation(double orientation[3]);


  double* GetOrientation() VTK_SIZEHINT(3);
  void GetOrientation(double orentation[3]);

  double* GetOrientationWXYZ() VTK_SIZEHINT(4);

  void AddOrientation(double x, double y, double z);

  void AddOrientation(double orentation[3]);

  void PokeMatrix(vtkMatrix4x4* matrix) override;

  void InitPathTraversal() override;

  vtkMTimeType GetMTime() override;

  vtkMTimeType GetUserTransformMatrixMTime();


  virtual void ComputeMatrix();


  vtkMatrix4x4* GetMatrix() override
  {
    this->ComputeMatrix();
    return this->Matrix;
  }


  vtkGetMacro(IsIdentity, vtkTypeBool);


  enum CoordinateSystems
  {
    WORLD = 0,
    PHYSICAL = 1,
    DEVICE = 2
  };
  void SetCoordinateSystemToWorld() { this->SetCoordinateSystem(WORLD); }
  void SetCoordinateSystemToPhysical() { this->SetCoordinateSystem(PHYSICAL); }
  void SetCoordinateSystemToDevice() { this->SetCoordinateSystem(DEVICE); }
  void SetCoordinateSystem(CoordinateSystems val);
  vtkGetMacro(CoordinateSystem, CoordinateSystems);
  const char* GetCoordinateSystemAsString();


  void SetCoordinateSystemRenderer(vtkRenderer* ren);
  vtkRenderer* GetCoordinateSystemRenderer();


  vtkSetMacro(CoordinateSystemDevice, int);
  vtkGetMacro(CoordinateSystemDevice, int);

protected:
  vtkProp3D();
  ~vtkProp3D() override;

  vtkLinearTransform* UserTransform;
  vtkMatrix4x4* UserMatrix;
  vtkMatrix4x4* Matrix;
  vtkTimeStamp MatrixMTime;
  double Origin[3];
  double Position[3];
  double Orientation[3];
  double Scale[3];
  double Center[3];
  vtkTransform* Transform;
  double Bounds[6];
  vtkProp3D* CachedProp3D; // support the PokeMatrix() method
  vtkTypeBool IsIdentity;

  int CoordinateSystemDevice;
  CoordinateSystems CoordinateSystem = WORLD;
  vtkWeakPointer<vtkRenderer> CoordinateSystemRenderer;
  vtkNew<vtkMatrix4x4> TempMatrix4x4;

private:
  vtkProp3D(const vtkProp3D&) = delete;
  void operator=(const vtkProp3D&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif