dox/Rendering/vtkProp3D.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkProp3D.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 __vtkProp3D_h
#define __vtkProp3D_h

#include "vtkProp.h"

class vtkRenderer;
class vtkTransform;
class vtkLinearTransform;

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

  void ShallowCopy(vtkProp *prop);


  virtual void SetPosition(double _arg1, double _arg2, double _arg3) 
    { 
      vtkDebugMacro(<< this->GetClassName() << " (" << this << 
      "): setting Position to (" << _arg1 << "," << _arg2 << "," << 
      _arg3 << ")"); 
      if ((this->Position[0] != _arg1)||
          (this->Position[1] != _arg2)||
          (this->Position[2] != _arg3)) 
        { 
        this->Position[0] = _arg1; 
        this->Position[1] = _arg2; 
        this->Position[2] = _arg3; 
        this->Modified(); 
        this->IsIdentity = 0;
        } 
    }; 
  virtual void SetPosition (double _arg[3]) 
    { 
      this->SetPosition (_arg[0], _arg[1], _arg[2]);
    } 
  vtkGetVectorMacro(Position,double,3);
  void AddPosition(double deltaPosition[3]);
  void AddPosition(double deltaX,double deltaY,double deltaZ);


  virtual void SetOrigin(double _arg1, double _arg2, double _arg3) 
    { 
      vtkDebugMacro(<< this->GetClassName() << " (" << this << 
      "): setting Origin to (" << _arg1 << "," << _arg2 << "," << 
      _arg3 << ")"); 
      if ((this->Origin[0] != _arg1)||
          (this->Origin[1] != _arg2)||
          (this->Origin[2] != _arg3)) 
        { 
        this->Origin[0] = _arg1; 
        this->Origin[1] = _arg2; 
        this->Origin[2] = _arg3; 
        this->Modified(); 
        this->IsIdentity = 0;
        } 
    }; 
  virtual void SetOrigin(double _arg[3]) 
    { 
      this->SetOrigin (_arg[0], _arg[1], _arg[2]);
    } 
  vtkGetVectorMacro(Origin,double,3);


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

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


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


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


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

  void GetBounds(double bounds[6]);
  virtual double *GetBounds() = 0;
  
  double *GetCenter();

  double *GetXRange();

  double *GetYRange();

  double *GetZRange();

  double GetLength();

  void RotateX(double);

  void RotateY(double);

  void RotateZ(double);

  void RotateWXYZ(double,double,double,double);

  void SetOrientation(double,double,double);

  void SetOrientation(double a[3]);


  double *GetOrientation();
  void GetOrientation(double o[3]);

  double *GetOrientationWXYZ();

  void AddOrientation(double,double,double);

  void AddOrientation(double a[3]);

  void PokeMatrix(vtkMatrix4x4 *matrix);

  void InitPathTraversal();

  unsigned long int GetMTime();

  unsigned long int GetUserTransformMatrixMTime();
 
  virtual void ComputeMatrix();


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


  vtkGetMacro(IsIdentity,int);
  
protected:
  vtkProp3D();
  ~vtkProp3D();

  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
  int           IsIdentity;
private:
  vtkProp3D(const vtkProp3D&);  // Not implemented.
  void operator=(const vtkProp3D&);  // Not implemented.
};

#endif