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 =========================================================================*/
39 #ifndef vtkAnnotatedCubeActor_h
40 #define vtkAnnotatedCubeActor_h
41 
42 #include "vtkRenderingAnnotationModule.h" // For export macro
43 #include "vtkProp3D.h"
44 
45 class vtkActor;
46 class vtkAppendPolyData;
47 class vtkAssembly;
48 class vtkCubeSource;
49 class vtkFeatureEdges;
50 class vtkPropCollection;
51 class vtkProperty;
52 class vtkRenderer;
53 class vtkTransform;
54 class vtkTransformFilter;
55 class vtkVectorText;
56 
57 class VTKRENDERINGANNOTATION_EXPORT vtkAnnotatedCubeActor : public vtkProp3D
58 {
59 public:
60  static vtkAnnotatedCubeActor *New();
62  void PrintSelf(ostream& os, vtkIndent indent) override;
63 
69  void GetActors(vtkPropCollection *) override;
70 
72 
75  int RenderOpaqueGeometry(vtkViewport *viewport) override;
76  int RenderTranslucentPolygonalGeometry(vtkViewport *viewport) override;
78 
82  int HasTranslucentPolygonalGeometry() override;
83 
87  void ShallowCopy(vtkProp *prop) override;
88 
94  void ReleaseGraphicsResources(vtkWindow *) override;
95 
97 
101  void GetBounds(double bounds[6]);
102  double *GetBounds() VTK_SIZEHINT(6) override;
104 
108  vtkMTimeType GetMTime() override;
109 
111 
114  void SetFaceTextScale(double);
115  vtkGetMacro(FaceTextScale, double);
117 
119 
122  vtkProperty *GetXPlusFaceProperty();
123  vtkProperty *GetXMinusFaceProperty();
124  vtkProperty *GetYPlusFaceProperty();
125  vtkProperty *GetYMinusFaceProperty();
126  vtkProperty *GetZPlusFaceProperty();
127  vtkProperty *GetZMinusFaceProperty();
129 
133  vtkProperty *GetCubeProperty();
134 
138  vtkProperty *GetTextEdgesProperty();
139 
141 
144  vtkSetStringMacro( XPlusFaceText );
145  vtkGetStringMacro( XPlusFaceText );
146  vtkSetStringMacro( XMinusFaceText );
147  vtkGetStringMacro( XMinusFaceText );
148  vtkSetStringMacro( YPlusFaceText );
149  vtkGetStringMacro( YPlusFaceText );
150  vtkSetStringMacro( YMinusFaceText );
151  vtkGetStringMacro( YMinusFaceText );
152  vtkSetStringMacro( ZPlusFaceText );
153  vtkGetStringMacro( ZPlusFaceText );
154  vtkSetStringMacro( ZMinusFaceText );
155  vtkGetStringMacro( ZMinusFaceText );
157 
159 
162  void SetTextEdgesVisibility(int);
163  int GetTextEdgesVisibility();
165 
167 
170  void SetCubeVisibility(int);
171  int GetCubeVisibility();
173 
175 
178  void SetFaceTextVisibility(int);
179  int GetFaceTextVisibility();
181 
183 
186  vtkSetMacro(XFaceTextRotation,double);
187  vtkGetMacro(XFaceTextRotation,double);
188  vtkSetMacro(YFaceTextRotation,double);
189  vtkGetMacro(YFaceTextRotation,double);
190  vtkSetMacro(ZFaceTextRotation,double);
191  vtkGetMacro(ZFaceTextRotation,double);
193 
197  vtkAssembly *GetAssembly()
198  { return this->Assembly; }
199 
200 protected:
202  ~vtkAnnotatedCubeActor() override;
203 
206 
210 
211  void UpdateProps();
212 
219 
221 
225 
232 
239 
242 
244 
245 private:
247  void operator=(const vtkAnnotatedCubeActor&) = delete;
248 };
249 
250 #endif
251 
vtkAnnotatedCubeActor::InternalTransform
vtkTransform * InternalTransform
Definition: vtkAnnotatedCubeActor.h:241
vtkAnnotatedCubeActor::XMinusFaceVectorText
vtkVectorText * XMinusFaceVectorText
Definition: vtkAnnotatedCubeActor.h:227
vtkAnnotatedCubeActor::ZMinusFaceVectorText
vtkVectorText * ZMinusFaceVectorText
Definition: vtkAnnotatedCubeActor.h:231
vtkAnnotatedCubeActor::TextEdgesActor
vtkActor * TextEdgesActor
Definition: vtkAnnotatedCubeActor.h:209
vtkProp3D
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:43
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:226
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:218
vtkAnnotatedCubeActor::XMinusFaceText
char * XMinusFaceText
Definition: vtkAnnotatedCubeActor.h:214
vtkAnnotatedCubeActor::YMinusFaceText
char * YMinusFaceText
Definition: vtkAnnotatedCubeActor.h:216
vtkTransform
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:54
vtkVectorText
create polygonal text
Definition: vtkVectorText.h:41
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:213
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:34
vtkAnnotatedCubeActor::YPlusFaceActor
vtkActor * YPlusFaceActor
Definition: vtkAnnotatedCubeActor.h:235
vtkAnnotatedCubeActor::ZPlusFaceText
char * ZPlusFaceText
Definition: vtkAnnotatedCubeActor.h:217
vtkAppendPolyData
appends one or more polygonal datasets together
Definition: vtkAppendPolyData.h:42
vtkAnnotatedCubeActor::XPlusFaceActor
vtkActor * XPlusFaceActor
Definition: vtkAnnotatedCubeActor.h:233
vtkAnnotatedCubeActor::YFaceTextRotation
double YFaceTextRotation
Definition: vtkAnnotatedCubeActor.h:223
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:57
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkAnnotatedCubeActor::YPlusFaceText
char * YPlusFaceText
Definition: vtkAnnotatedCubeActor.h:215
vtkAnnotatedCubeActor::InternalTransformFilter
vtkTransformFilter * InternalTransformFilter
Definition: vtkAnnotatedCubeActor.h:240
vtkAnnotatedCubeActor::ZPlusFaceVectorText
vtkVectorText * ZPlusFaceVectorText
Definition: vtkAnnotatedCubeActor.h:230
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:45
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkAnnotatedCubeActor::YMinusFaceActor
vtkActor * YMinusFaceActor
Definition: vtkAnnotatedCubeActor.h:236
vtkFeatureEdges
extract boundary, non-manifold, and/or sharp edges from polygonal data
Definition: vtkFeatureEdges.h:46
vtkAnnotatedCubeActor::ZPlusFaceActor
vtkActor * ZPlusFaceActor
Definition: vtkAnnotatedCubeActor.h:237
vtkAnnotatedCubeActor::AppendTextEdges
vtkAppendPolyData * AppendTextEdges
Definition: vtkAnnotatedCubeActor.h:207
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:44
vtkAnnotatedCubeActor::ZMinusFaceText
char * ZMinusFaceText
Definition: vtkAnnotatedCubeActor.h:218
vtkProp::RenderTranslucentPolygonalGeometry
virtual int RenderTranslucentPolygonalGeometry(vtkViewport *)
Definition: vtkProp.h:220
vtkAnnotatedCubeActor::XMinusFaceActor
vtkActor * XMinusFaceActor
Definition: vtkAnnotatedCubeActor.h:234
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:46
vtkProp3D::ShallowCopy
void ShallowCopy(vtkProp *prop) override
Shallow copy of this vtkProp3D.
vtkAnnotatedCubeActor::CubeSource
vtkCubeSource * CubeSource
Definition: vtkAnnotatedCubeActor.h:204
vtkAnnotatedCubeActor::ZFaceTextRotation
double ZFaceTextRotation
Definition: vtkAnnotatedCubeActor.h:224
vtkCubeSource
create a polygonal representation of a cube
Definition: vtkCubeSource.h:30
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:57
vtkAnnotatedCubeActor::FaceTextScale
double FaceTextScale
Definition: vtkAnnotatedCubeActor.h:220
vtkAnnotatedCubeActor::YMinusFaceVectorText
vtkVectorText * YMinusFaceVectorText
Definition: vtkAnnotatedCubeActor.h:229
vtkTransformFilter
transform points and associated normals and vectors
Definition: vtkTransformFilter.h:46
vtkAnnotatedCubeActor::ExtractTextEdges
vtkFeatureEdges * ExtractTextEdges
Definition: vtkAnnotatedCubeActor.h:208
vtkAnnotatedCubeActor::Assembly
vtkAssembly * Assembly
Definition: vtkAnnotatedCubeActor.h:243
vtkProperty
represent surface properties of a geometric object
Definition: vtkProperty.h:60
vtkAnnotatedCubeActor::XFaceTextRotation
double XFaceTextRotation
Definition: vtkAnnotatedCubeActor.h:222
vtkPropCollection
an ordered list of Props
Definition: vtkPropCollection.h:35
vtkAnnotatedCubeActor::ZMinusFaceActor
vtkActor * ZMinusFaceActor
Definition: vtkAnnotatedCubeActor.h:238
vtkProp::ReleaseGraphicsResources
virtual void ReleaseGraphicsResources(vtkWindow *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
Definition: vtkProp.h:299
vtkAnnotatedCubeActor::YPlusFaceVectorText
vtkVectorText * YPlusFaceVectorText
Definition: vtkAnnotatedCubeActor.h:228
vtkProp::HasTranslucentPolygonalGeometry
virtual int HasTranslucentPolygonalGeometry()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition: vtkProp.h:290
vtkAnnotatedCubeActor::CubeActor
vtkActor * CubeActor
Definition: vtkAnnotatedCubeActor.h:205
vtkAnnotatedCubeActor
a 3D cube with face labels
Definition: vtkAnnotatedCubeActor.h:57
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302
vtkProp3D.h
vtkAssembly
create hierarchies of vtkProp3Ds (transformable props)
Definition: vtkAssembly.h:69