VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkStructuredExtent Class Reference

helper class to aid working with structured extents. More...

#include <vtkStructuredExtent.h>

Inheritance diagram for vtkStructuredExtent:
[legend]
Collaboration diagram for vtkStructuredExtent:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkStructuredExtentNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkStructuredExtentNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkStructuredExtentSafeDownCast (vtkObjectBase *o)
 
static void Clamp (int ext[6], const int wholeExt[])
 Clamps ext to fit in wholeExt. More...
 
static bool StrictlySmaller (const int ext[6], const int wholeExt[6])
 Returns true if ext is fits within wholeExt with at least 1 dimension smaller than the wholeExt. More...
 
static bool Smaller (const int ext[6], const int wholeExt[6])
 Returns if ext fits within wholeExt. More...
 
static void Grow (int ext[6], int count)
 Grows the ext on each side by the given count. More...
 
static void Grow (int ext[6], int count, int wholeExt[6])
 Grows the ext on each side by the given count while keeping it limited to the wholeExt. More...
 
static void Transform (int ext[6], int wholeExt[6])
 Makes ext relative to wholeExt. More...
 
static void GetDimensions (const int ext[6], int dims[3])
 Given the extents, computes the dimensions. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkStructuredExtent ()
 
 ~vtkStructuredExtent () 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

helper class to aid working with structured extents.

vtkStructuredExtent is an helper class that helps in arithmetic with structured extents. It defines a bunch of static methods (most of which are inlined) to aid in dealing with extents.

Tests:
vtkStructuredExtent (Tests)

Definition at line 35 of file vtkStructuredExtent.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkStructuredExtent.h.

Constructor & Destructor Documentation

◆ vtkStructuredExtent()

vtkStructuredExtent::vtkStructuredExtent ( )
protected

◆ ~vtkStructuredExtent()

vtkStructuredExtent::~vtkStructuredExtent ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkStructuredExtent* vtkStructuredExtent::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkStructuredExtent::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkStructuredExtent::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkStructuredExtent* vtkStructuredExtent::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkStructuredExtent::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkStructuredExtent* vtkStructuredExtent::NewInstance ( ) const

◆ PrintSelf()

void vtkStructuredExtent::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ Clamp()

void vtkStructuredExtent::Clamp ( int  ext[6],
const int  wholeExt[] 
)
inlinestatic

Clamps ext to fit in wholeExt.

Definition at line 92 of file vtkStructuredExtent.h.

◆ StrictlySmaller()

bool vtkStructuredExtent::StrictlySmaller ( const int  ext[6],
const int  wholeExt[6] 
)
inlinestatic

Returns true if ext is fits within wholeExt with at least 1 dimension smaller than the wholeExt.

Definition at line 129 of file vtkStructuredExtent.h.

◆ Smaller()

bool vtkStructuredExtent::Smaller ( const int  ext[6],
const int  wholeExt[6] 
)
inlinestatic

Returns if ext fits within wholeExt.

Unlike StrictlySmaller, this method returns true even if ext == wholeExt.

Definition at line 105 of file vtkStructuredExtent.h.

◆ Grow() [1/2]

void vtkStructuredExtent::Grow ( int  ext[6],
int  count 
)
inlinestatic

Grows the ext on each side by the given count.

Definition at line 148 of file vtkStructuredExtent.h.

◆ Grow() [2/2]

void vtkStructuredExtent::Grow ( int  ext[6],
int  count,
int  wholeExt[6] 
)
inlinestatic

Grows the ext on each side by the given count while keeping it limited to the wholeExt.

Definition at line 160 of file vtkStructuredExtent.h.

◆ Transform()

void vtkStructuredExtent::Transform ( int  ext[6],
int  wholeExt[6] 
)
inlinestatic

Makes ext relative to wholeExt.

Definition at line 167 of file vtkStructuredExtent.h.

◆ GetDimensions()

void vtkStructuredExtent::GetDimensions ( const int  ext[6],
int  dims[3] 
)
inlinestatic

Given the extents, computes the dimensions.

Definition at line 180 of file vtkStructuredExtent.h.


The documentation for this class was generated from the following file: