internal storage class used by vtkSOADataArrayTemplate, vtkAOSDataArrayTemplate, and others. More...
#include <vtkBuffer.h>
Inheritance diagram for vtkBuffer< ScalarTypeT >:
Collaboration diagram for vtkBuffer< ScalarTypeT >:
Public Member Functions | |
| vtkTemplateTypeMacro (vtkBuffer< ScalarTypeT >, vtkObject) typedef ScalarTypeT ScalarType | |
| ScalarType * | GetBuffer () |
| Access the buffer as a scalar pointer. More... | |
| const ScalarType * | GetBuffer () const |
| void | SetBuffer (ScalarType *array, vtkIdType size) |
| Set the memory buffer that this vtkBuffer object will manage. More... | |
| void | SetFreeFunction (bool noFreeFunction, void(*deleteFunction)(void *)=free) |
| Set the free function to be used when releasing this object. More... | |
| vtkIdType | GetSize () const |
| Return the number of elements the current buffer can hold. More... | |
| bool | Allocate (vtkIdType size) |
| Allocate a new buffer that holds size elements. More... | |
| bool | Reallocate (vtkIdType newsize) |
| Allocate a new buffer that holds newsize elements. More... | |
 Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual void | Modified () |
| Update the modification time for this object. More... | |
| virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More... | |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| vtkTypeBool | HasObserver (unsigned long event) |
| vtkTypeBool | HasObserver (const char *event) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual vtkTypeBool | IsA (const char *name) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
| static vtkBuffer< ScalarTypeT > * | New () |
| Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| vtkBuffer () | |
| ~vtkBuffer () override | |
| Protected Member Functions inherited from vtkObject | |
| vtkObject () | |
| ~vtkObject () override | |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events. More... | |
| void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events. More... | |
| Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Protected Attributes | |
| ScalarType * | Pointer |
| vtkIdType | Size |
| void(* | DeleteFunction )(void *) |
| Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
Detailed Description
template<class ScalarTypeT>
class vtkBuffer< ScalarTypeT >
internal storage class used by vtkSOADataArrayTemplate, vtkAOSDataArrayTemplate, and others.
vtkBuffer makes it easier to keep data pointers in vtkDataArray subclasses. This is an internal class and not intended for direct use expect when writing new types of vtkDataArray subclasses.
Definition at line 32 of file vtkBuffer.h.
Constructor & Destructor Documentation
Definition at line 78 of file vtkBuffer.h.
Definition at line 85 of file vtkBuffer.h.
Member Function Documentation
template<class ScalarTypeT>
| vtkBuffer< ScalarTypeT >::vtkTemplateTypeMacro | ( | vtkBuffer< ScalarTypeT > | , |
| vtkObject | |||
| ) |
Definition at line 100 of file vtkBuffer.h.
template<class ScalarTypeT>
|
inline |
Access the buffer as a scalar pointer.
Definition at line 43 of file vtkBuffer.h.
template<class ScalarTypeT>
|
inline |
Definition at line 44 of file vtkBuffer.h.
template<class ScalarTypeT>
| void vtkBuffer< ScalarT >::SetBuffer | ( | ScalarType * | array, |
| vtkIdType | size | ||
| ) |
Set the memory buffer that this vtkBuffer object will manage.
array is a pointer to the buffer data and size is the size of the buffer (in number of elements).
Definition at line 107 of file vtkBuffer.h.
template<typename ScalarT >
| void vtkBuffer< ScalarT >::SetFreeFunction | ( | bool | noFreeFunction, |
| void(*)(void *) | deleteFunction = free |
||
| ) |
Set the free function to be used when releasing this object.
If noFreeFunction is true, the buffer will not be freed when this vtkBuffer object is deleted or resize – otherwise, deleteFunction will be called to free the buffer
Definition at line 121 of file vtkBuffer.h.
Return the number of elements the current buffer can hold.
Definition at line 64 of file vtkBuffer.h.
Allocate a new buffer that holds size elements.
Old data is not saved.
Definition at line 135 of file vtkBuffer.h.
Allocate a new buffer that holds newsize elements.
Old data is preserved.
Definition at line 156 of file vtkBuffer.h.
Member Data Documentation
template<class ScalarTypeT>
|
protected |
Definition at line 90 of file vtkBuffer.h.
Definition at line 91 of file vtkBuffer.h.
template<class ScalarTypeT>
|
protected |
Definition at line 92 of file vtkBuffer.h.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/Core/vtkBuffer.h
