ParaView
|
double range domain based on data set bounds More...
#include <vtkSMBoundsDomain.h>
Public Types | |
enum | Modes { NORMAL, MAGNITUDE, ORIENTED_MAGNITUDE, SCALED_EXTENT, ARRAY_SCALED_EXTENT, APPROXIMATE_CELL_LENGTH, DATA_BOUNDS, EXTENTS } |
SCALED_EXTENT: is used for vtkPVScaleFactorEntry. More... | |
typedef vtkSMDoubleRangeDomain | Superclass |
![]() | |
typedef vtkSMDomain | Superclass |
![]() | |
typedef vtkSMSessionObject | Superclass |
![]() | |
typedef vtkSMObject | Superclass |
![]() | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual void | Update (vtkSMProperty *) |
Update self checking the "unchecked" values of all required properties. More... | |
virtual double | GetScaleFactor () |
virtual int | SetDefaultValues (vtkSMProperty *property, bool use_unchecked_values) |
Overridden to handle APPROXIMATE_CELL_LENGTH. More... | |
virtual void | SetMode (int) |
virtual int | GetMode () |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
double | GetMinimum (unsigned int idx, int &exists) |
Return a min. More... | |
double | GetMaximum (unsigned int idx, int &exists) |
Return a max. More... | |
int | GetMinimumExists (unsigned int idx) |
Returns if minimum/maximum bound is set for the domain. More... | |
int | GetMaximumExists (unsigned int idx) |
double | GetMinimum (unsigned int idx) |
Returns the minimum/maximum value, is exists, otherwise 0 is returned. More... | |
double | GetMaximum (unsigned int idx) |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual int | IsInDomain (vtkSMProperty *property)=0 |
Is the (unchecked) value of the property in the domain? Overwritten by sub-classes. More... | |
virtual void | SetAnimationValue (vtkSMProperty *, int vtkNotUsed(index), double vtkNotUsed(value)) |
Set the value of an element of a property from the animation editor. More... | |
virtual int | SetDefaultValues (vtkSMProperty *, bool vtkNotUsed(use_unchecked_values)) |
A vtkSMProperty is often defined with a default value in the XML itself. More... | |
vtkSMProperty * | GetProperty () |
Provides access to the vtkSMProperty on which this domain is hooked up. More... | |
virtual char * | GetXMLName () |
Assigned by the XML parser. More... | |
virtual bool | GetIsOptional () |
When the IsOptional flag is set, IsInDomain() always returns true. More... | |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual vtkSMSessionProxyManager * | GetSessionProxyManager () |
Return the corresponding ProxyManager if any. More... | |
virtual void | SetSession (vtkSMSession *) |
Get/Set the session on wihch this object exists. More... | |
virtual vtkSMSession * | GetSession () |
Get/Set the session on wihch this object exists. More... | |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
Static Public Member Functions | |
static vtkSMBoundsDomain * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMBoundsDomain * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkSMDoubleRangeDomain * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMDoubleRangeDomain * | SafeDownCast (vtkObject *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkSMDomain * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkSMSessionObject * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMSessionObject * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkSMObject * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMObject * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
vtkSMBoundsDomain () | |
~vtkSMBoundsDomain () | |
virtual int | ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) |
Set the appropriate ivars from the xml element. More... | |
vtkPVDataInformation * | GetInputInformation () |
void | SetDomainValues (double bounds[6]) |
void | UpdateOriented () |
![]() | |
vtkSMDoubleRangeDomain () | |
~vtkSMDoubleRangeDomain () | |
![]() | |
vtkSMDomain () | |
~vtkSMDomain () | |
virtual int | LoadState (vtkPVXMLElement *vtkNotUsed(domainElement), vtkSMProxyLocator *vtkNotUsed(loader)) |
Load the state of the domain from the XML. More... | |
vtkSMProperty * | GetRequiredProperty (const char *function) |
Returns a given required property of the given function. More... | |
void | RemoveRequiredProperty (vtkSMProperty *prop) |
Remove the given property from the required properties list. More... | |
void | AddRequiredProperty (vtkSMProperty *prop, const char *function) |
Add a new required property to this domain. More... | |
virtual vtkPVDataInformation * | GetInputDataInformation (const char *function, int index=0) |
Helper method to get vtkPVDataInformation from input proxy connected to the required property with the given function. More... | |
void | DomainModified () |
Invokes DomainModifiedEvent. More... | |
void | InvokeModified () |
unsigned int | GetNumberOfRequiredProperties () |
Gets the number of required properties added. More... | |
void | SetProperty (vtkSMProperty *) |
Set the domain's property. More... | |
void | SaveState (vtkPVXMLElement *parent, const char *uid) |
Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More... | |
virtual void | ChildSaveState (vtkPVXMLElement *domainElement) |
Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More... | |
virtual void | SetIsOptional (bool) |
When the IsOptional flag is set, IsInDomain() always returns true. More... | |
virtual void | SetXMLName (const char *) |
Assigned by the XML parser. More... | |
![]() | |
vtkSMSessionObject () | |
~vtkSMSessionObject () | |
![]() | |
vtkSMObject () | |
~vtkSMObject () | |
Protected Attributes | |
int | Mode |
double | ScaleFactor |
![]() | |
char * | XMLName |
bool | IsOptional |
vtkSMDomainInternals * | Internals |
![]() | |
vtkWeakPointer< vtkSMSession > | Session |
double range domain based on data set bounds
vtkSMBoundsDomain extends vtkSMDoubleRangeDomain to add support to determine the valid range for the values based on the dataset bounds. There are several Modes
which can be used to control how the range is computed based on the data bounds (defined by the vtkSMBoundsDomain::Modes enum).
NORMAL
: this is the basic mode where the domain will have 3 ranges which are the min and max for the bounds along each of the coordinate axis. MAGNITUDE:
the domain has a single range set to (-magn/2.0, +magn/2.0) where magn is the magnitude of the diagonal. ORIENTED_MAGNITUDE:
same as MAGNITUDE, but instead of the dialog, a vector determined using two additional required properties with functions Normal, and Origin is used. li SCALED_EXTENT:
the range is set to (0, maxbounds * this->ScaleFactor) where maxbounds is the length of the longest axis for the bounding box. li ARRAY_SCALED_EXTENT:
the range is set to (0, (arrayMagnitude / maxbounds) * this->ScaleFactor) where maxbounds is the length of the longest axis for the bounding box. and arrayMagnitude the maximum magnitude of the array. li APPROXIMATE_CELL_LENGTH:
approximation for cell length computed using the li DATA_BOUNDS:
this mode for a 6 tuple property that takes the data bounds. The range will have 6 ranges: (xmin,xmax), (xmin,xmax), (ymin,ymax), (ymin,ymax), (zmin,zmax), and (zmin,zmax). If default_mode is not specified, then "min,max,min,max,min,max" is assumed. li EXTENTS:
this mode for a property that takes a value between 0 and (max-min) for each component.To determine the input data bounds, this domain depends on a required property with function Input
. The data-information from the source-proxy set as the value for that property is used to determine the bounds.
Supported XML attributes:
mode
: used to specify the Mode. Value can be "normal", "magnitude", "oriented_magnitude", "scaled_extent", "array_scaled_extent", or "approximate_cell_length", "data_bounds". scale_factor
: used in SCALED_EXTENT, ARRAY_SCALED_EXTENT and APPROXIMATE_CELL_LENGTH mode. Value is a floating point number that is used as the scale factor. Definition at line 67 of file vtkSMBoundsDomain.h.
Definition at line 71 of file vtkSMBoundsDomain.h.
SCALED_EXTENT: is used for vtkPVScaleFactorEntry.
Enumerator | |
---|---|
NORMAL | |
MAGNITUDE | |
ORIENTED_MAGNITUDE | |
SCALED_EXTENT | |
ARRAY_SCALED_EXTENT | |
APPROXIMATE_CELL_LENGTH | |
DATA_BOUNDS | |
EXTENTS |
Definition at line 88 of file vtkSMBoundsDomain.h.
|
protected |
|
protected |
|
static |
|
virtual |
Reimplemented from vtkSMDoubleRangeDomain.
|
static |
|
virtual |
Reimplemented from vtkSMDoubleRangeDomain.
|
static |
void vtkSMBoundsDomain::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
Update self checking the "unchecked" values of all required properties.
Overwritten by sub-classes.
Reimplemented from vtkSMDomain.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Overridden to handle APPROXIMATE_CELL_LENGTH.
|
protectedvirtual |
Set the appropriate ivars from the xml element.
Should be overwritten by subclass if adding ivars.
Reimplemented from vtkSMDomain.
|
protected |
|
protected |
|
protected |
|
protected |
Definition at line 125 of file vtkSMBoundsDomain.h.
|
protected |
Definition at line 126 of file vtkSMBoundsDomain.h.