VTK
vtkAnnotatedCubeActor.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAnnotatedCubeActor.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
42 #ifndef vtkAnnotatedCubeActor_h
43 #define vtkAnnotatedCubeActor_h
44 
45 #include "vtkRenderingAnnotationModule.h" // For export macro
46 #include "vtkProp3D.h"
47 
48 class vtkActor;
49 class vtkAppendPolyData;
50 class vtkAssembly;
51 class vtkCubeSource;
52 class vtkFeatureEdges;
53 class vtkPropCollection;
54 class vtkProperty;
55 class vtkRenderer;
56 class vtkTransform;
57 class vtkTransformFilter;
58 class vtkVectorText;
59 
60 class VTKRENDERINGANNOTATION_EXPORT vtkAnnotatedCubeActor : public vtkProp3D
61 {
62 public:
63  static vtkAnnotatedCubeActor *New();
65  void PrintSelf(ostream& os, vtkIndent indent) override;
66 
72  void GetActors(vtkPropCollection *) override;
73 
75 
78  int RenderOpaqueGeometry(vtkViewport *viewport) override;
79  int RenderTranslucentPolygonalGeometry(vtkViewport *viewport) override;
81 
86 
90  void ShallowCopy(vtkProp *prop) override;
91 
97  void ReleaseGraphicsResources(vtkWindow *) override;
98 
100 
104  void GetBounds(double bounds[6]);
105  double *GetBounds() VTK_SIZEHINT(6) override;
107 
111  vtkMTimeType GetMTime() override;
112 
114 
117  void SetFaceTextScale(double);
118  vtkGetMacro(FaceTextScale, double);
120 
122 
125  vtkProperty *GetXPlusFaceProperty();
126  vtkProperty *GetXMinusFaceProperty();
127  vtkProperty *GetYPlusFaceProperty();
128  vtkProperty *GetYMinusFaceProperty();
129  vtkProperty *GetZPlusFaceProperty();
130  vtkProperty *GetZMinusFaceProperty();
132 
136  vtkProperty *GetCubeProperty();
137 
141  vtkProperty *GetTextEdgesProperty();
142 
144 
147  vtkSetStringMacro( XPlusFaceText );
148  vtkGetStringMacro( XPlusFaceText );
149  vtkSetStringMacro( XMinusFaceText );
150  vtkGetStringMacro( XMinusFaceText );
151  vtkSetStringMacro( YPlusFaceText );
152  vtkGetStringMacro( YPlusFaceText );
153  vtkSetStringMacro( YMinusFaceText );
154  vtkGetStringMacro( YMinusFaceText );
155  vtkSetStringMacro( ZPlusFaceText );
156  vtkGetStringMacro( ZPlusFaceText );
157  vtkSetStringMacro( ZMinusFaceText );
158  vtkGetStringMacro( ZMinusFaceText );
160 
162 
165  void SetTextEdgesVisibility(int);
166  int GetTextEdgesVisibility();
168 
170 
173  void SetCubeVisibility(int);
174  int GetCubeVisibility();
176 
178 
181  void SetFaceTextVisibility(int);
182  int GetFaceTextVisibility();
184 
186 
189  vtkSetMacro(XFaceTextRotation,double);
190  vtkGetMacro(XFaceTextRotation,double);
191  vtkSetMacro(YFaceTextRotation,double);
192  vtkGetMacro(YFaceTextRotation,double);
193  vtkSetMacro(ZFaceTextRotation,double);
194  vtkGetMacro(ZFaceTextRotation,double);
196 
200  vtkAssembly *GetAssembly()
201  { return this->Assembly; }
202 
203 protected:
205  ~vtkAnnotatedCubeActor() override;
206 
209 
213 
214  void UpdateProps();
215 
222 
224 
228 
235 
242 
245 
247 
248 private:
250  void operator=(const vtkAnnotatedCubeActor&) = delete;
251 };
252 
253 #endif
254 
vtkAnnotatedCubeActor::InternalTransform
vtkTransform * InternalTransform
Definition: vtkAnnotatedCubeActor.h:244
vtkAnnotatedCubeActor::XMinusFaceVectorText
vtkVectorText * XMinusFaceVectorText
Definition: vtkAnnotatedCubeActor.h:230
vtkAnnotatedCubeActor::ZMinusFaceVectorText
vtkVectorText * ZMinusFaceVectorText
Definition: vtkAnnotatedCubeActor.h:234
vtkAnnotatedCubeActor::TextEdgesActor
vtkActor * TextEdgesActor
Definition: vtkAnnotatedCubeActor.h:212
vtkProp3D
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:46
vtkProp3D::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAnnotatedCubeActor::XPlusFaceVectorText
vtkVectorText * XPlusFaceVectorText
Definition: vtkAnnotatedCubeActor.h:229
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkProp::RenderOpaqueGeometry
virtual int RenderOpaqueGeometry(vtkViewport *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition: vtkProp.h:224
vtkAnnotatedCubeActor::XMinusFaceText
char * XMinusFaceText
Definition: vtkAnnotatedCubeActor.h:217
vtkAnnotatedCubeActor::YMinusFaceText
char * YMinusFaceText
Definition: vtkAnnotatedCubeActor.h:219
vtkTransform
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:60
vtkVectorText
create polygonal text
Definition: vtkVectorText.h:47
vtkProp3D::GetBounds
double * GetBounds() override=0
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
vtkAnnotatedCubeActor::XPlusFaceText
char * XPlusFaceText
Definition: vtkAnnotatedCubeActor.h:216
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
vtkAnnotatedCubeActor::YPlusFaceActor
vtkActor * YPlusFaceActor
Definition: vtkAnnotatedCubeActor.h:238
vtkAnnotatedCubeActor::ZPlusFaceText
char * ZPlusFaceText
Definition: vtkAnnotatedCubeActor.h:220
vtkProp::HasTranslucentPolygonalGeometry
virtual vtkTypeBool HasTranslucentPolygonalGeometry()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition: vtkProp.h:296
vtkAppendPolyData
appends one or more polygonal datasets together
Definition: vtkAppendPolyData.h:48
vtkAnnotatedCubeActor::XPlusFaceActor
vtkActor * XPlusFaceActor
Definition: vtkAnnotatedCubeActor.h:236
vtkAnnotatedCubeActor::YFaceTextRotation
double YFaceTextRotation
Definition: vtkAnnotatedCubeActor.h:226
vtkProp::GetActors
virtual void GetActors(vtkPropCollection *)
For some exporters and other other operations we must be able to collect all the actors or volumes.
Definition: vtkProp.h:63
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkAnnotatedCubeActor::YPlusFaceText
char * YPlusFaceText
Definition: vtkAnnotatedCubeActor.h:218
vtkAnnotatedCubeActor::InternalTransformFilter
vtkTransformFilter * InternalTransformFilter
Definition: vtkAnnotatedCubeActor.h:243
vtkAnnotatedCubeActor::ZPlusFaceVectorText
vtkVectorText * ZPlusFaceVectorText
Definition: vtkAnnotatedCubeActor.h:233
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:51
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkAnnotatedCubeActor::YMinusFaceActor
vtkActor * YMinusFaceActor
Definition: vtkAnnotatedCubeActor.h:239
vtkFeatureEdges
extract boundary, non-manifold, and/or sharp edges from polygonal data
Definition: vtkFeatureEdges.h:49
vtkAnnotatedCubeActor::ZPlusFaceActor
vtkActor * ZPlusFaceActor
Definition: vtkAnnotatedCubeActor.h:240
vtkAnnotatedCubeActor::AppendTextEdges
vtkAppendPolyData * AppendTextEdges
Definition: vtkAnnotatedCubeActor.h:210
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:47
vtkAnnotatedCubeActor::ZMinusFaceText
char * ZMinusFaceText
Definition: vtkAnnotatedCubeActor.h:221
vtkProp::RenderTranslucentPolygonalGeometry
virtual int RenderTranslucentPolygonalGeometry(vtkViewport *)
Definition: vtkProp.h:226
vtkAnnotatedCubeActor::XMinusFaceActor
vtkActor * XMinusFaceActor
Definition: vtkAnnotatedCubeActor.h:237
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:52
vtkProp3D::ShallowCopy
void ShallowCopy(vtkProp *prop) override
Shallow copy of this vtkProp3D.
vtkAnnotatedCubeActor::CubeSource
vtkCubeSource * CubeSource
Definition: vtkAnnotatedCubeActor.h:207
vtkAnnotatedCubeActor::ZFaceTextRotation
double ZFaceTextRotation
Definition: vtkAnnotatedCubeActor.h:227
vtkCubeSource
create a polygonal representation of a cube
Definition: vtkCubeSource.h:36
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:63
vtkAnnotatedCubeActor::FaceTextScale
double FaceTextScale
Definition: vtkAnnotatedCubeActor.h:223
vtkAnnotatedCubeActor::YMinusFaceVectorText
vtkVectorText * YMinusFaceVectorText
Definition: vtkAnnotatedCubeActor.h:232
vtkTransformFilter
transform points and associated normals and vectors
Definition: vtkTransformFilter.h:52
vtkAnnotatedCubeActor::ExtractTextEdges
vtkFeatureEdges * ExtractTextEdges
Definition: vtkAnnotatedCubeActor.h:211
vtkAnnotatedCubeActor::Assembly
vtkAssembly * Assembly
Definition: vtkAnnotatedCubeActor.h:246
vtkProperty
represent surface properties of a geometric object
Definition: vtkProperty.h:66
vtkAnnotatedCubeActor::XFaceTextRotation
double XFaceTextRotation
Definition: vtkAnnotatedCubeActor.h:225
vtkPropCollection
an ordered list of Props
Definition: vtkPropCollection.h:41
vtkAnnotatedCubeActor::ZMinusFaceActor
vtkActor * ZMinusFaceActor
Definition: vtkAnnotatedCubeActor.h:241
vtkProp::ReleaseGraphicsResources
virtual void ReleaseGraphicsResources(vtkWindow *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
Definition: vtkProp.h:305
vtkAnnotatedCubeActor::YPlusFaceVectorText
vtkVectorText * YPlusFaceVectorText
Definition: vtkAnnotatedCubeActor.h:231
vtkAnnotatedCubeActor::CubeActor
vtkActor * CubeActor
Definition: vtkAnnotatedCubeActor.h:208
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkAnnotatedCubeActor
a 3D cube with face labels
Definition: vtkAnnotatedCubeActor.h:60
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302
vtkProp3D.h
vtkAssembly
create hierarchies of vtkProp3Ds (transformable props)
Definition: vtkAssembly.h:75