File: vtkActorCollection.h

package info (click to toggle)
paraview 5.11.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 497,236 kB
  • sloc: cpp: 3,171,290; ansic: 1,315,072; python: 134,290; xml: 103,324; sql: 65,887; sh: 5,286; javascript: 4,901; yacc: 4,383; java: 3,977; perl: 2,363; lex: 1,909; f90: 1,255; objc: 143; makefile: 119; tcl: 59; pascal: 50; fortran: 29
file content (130 lines) | stat: -rw-r--r-- 3,247 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkActorCollection.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.

=========================================================================*/
/**
 * @class   vtkActorCollection
 * @brief   an ordered list of actors
 *
 * vtkActorCollection represents and provides methods to manipulate a list of
 * actors (i.e., vtkActor and subclasses). The list is ordered and duplicate
 * entries are not prevented.
 *
 * @sa
 * vtkActor vtkCollection
 */

#ifndef vtkActorCollection_h
#define vtkActorCollection_h

#include "vtkActor.h" // For inline methods
#include "vtkPropCollection.h"
#include "vtkRenderingCoreModule.h" // For export macro

VTK_ABI_NAMESPACE_BEGIN
class vtkProperty;

class VTKRENDERINGCORE_EXPORT vtkActorCollection : public vtkPropCollection
{
public:
  static vtkActorCollection* New();
  vtkTypeMacro(vtkActorCollection, vtkPropCollection);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  /**
   * Add an actor to the bottom of the list.
   */
  void AddItem(vtkActor* a);

  /**
   * Get the next actor in the list.
   */
  vtkActor* GetNextActor();

  /**
   * Get the last actor in the list.
   */
  vtkActor* GetLastActor();

  ///@{
  /**
   * Access routines that are provided for compatibility with previous
   * version of VTK.  Please use the GetNextActor(), GetLastActor() variants
   * where possible.
   */
  vtkActor* GetNextItem();
  vtkActor* GetLastItem();
  ///@}

  /**
   * Apply properties to all actors in this collection.
   */
  void ApplyProperties(vtkProperty* p);

  /**
   * Reentrant safe way to get an object in a collection. Just pass the
   * same cookie back and forth.
   */
  vtkActor* GetNextActor(vtkCollectionSimpleIterator& cookie)
  {
    return static_cast<vtkActor*>(this->GetNextItemAsObject(cookie));
  }

protected:
  vtkActorCollection() = default;
  ~vtkActorCollection() override = default;

private:
  // hide the standard AddItem from the user and the compiler.
  void AddItem(vtkObject* o) { this->vtkCollection::AddItem(o); }
  void AddItem(vtkProp* o) { this->vtkPropCollection::AddItem(o); }

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

inline void vtkActorCollection::AddItem(vtkActor* a)
{
  this->vtkCollection::AddItem(a);
}

inline vtkActor* vtkActorCollection::GetNextActor()
{
  return static_cast<vtkActor*>(this->GetNextItemAsObject());
}

inline vtkActor* vtkActorCollection::GetLastActor()
{
  if (this->Bottom == nullptr)
  {
    return nullptr;
  }
  else
  {
    return static_cast<vtkActor*>(this->Bottom->Item);
  }
}

inline vtkActor* vtkActorCollection::GetNextItem()
{
  return this->GetNextActor();
}

inline vtkActor* vtkActorCollection::GetLastItem()
{
  return this->GetLastActor();
}

VTK_ABI_NAMESPACE_END
#endif