ParaView
|
domain used to restrict an vtkSMIntVectorProperty values to valid flat-index
for a vtkCompositeDataSet.
More...
#include <vtkSMCompositeTreeDomain.h>
Public Types | |
enum | { ALL = 0, LEAVES = 1, NON_LEAVES = 2, NONE = 3 } |
enum | DefaultModes { DEFAULT = 0, NONEMPTY_LEAF = 1 } |
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 *input) |
Called when the 'required-property' is modified. More... | |
vtkSMSourceProxy * | GetSource () |
Returns the source proxy whose data information is returned by GetInformation(). More... | |
virtual int | IsInDomain (vtkSMProperty *vtkNotUsed(property)) |
Is the (unchecked) value of the property in the domain? Overwritten by sub-classes. More... | |
virtual int | SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) |
A vtkSMProperty is often defined with a default value in the XML itself. More... | |
virtual vtkPVDataInformation * | GetInformation () |
Get the vtkPVDataInformation which provides the tree structure for the composite dataset. More... | |
virtual int | GetSourcePort () |
Returns the port for the source proxy from which the data information is obtained by GetInformation(). More... | |
virtual int | GetMode () |
Mode indicates if the property is interested in all nodes, leaves only or non-leaves only. More... | |
virtual void | SetMode (int) |
Mode indicates if the property is interested in all nodes, leaves only or non-leaves only. More... | |
virtual int | GetDefaultMode () |
DefaultMode controls how the default value for the property is set by SetDefaultValues(). More... | |
virtual void | SetDefaultMode (int) |
DefaultMode controls how the default value for the property is set by SetDefaultValues(). More... | |
![]() | |
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 vtkSMCompositeTreeDomain * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMCompositeTreeDomain * | 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 | |
vtkSMCompositeTreeDomain () | |
~vtkSMCompositeTreeDomain () | |
virtual int | ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) |
Set the appropriate ivars from the xml element. More... | |
void | Update (vtkSMInputProperty *iproperty) |
Internal implementation called by Update(vtkSMProperty*);. More... | |
void | InvokeModifiedIfChanged () |
void | SetInformation (vtkPVDataInformation *) |
![]() | |
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 | |
vtkPVDataInformation * | Information |
vtkTimeStamp | UpdateTime |
vtkPVDataInformation * | LastInformation |
vtkWeakPointer< vtkSMSourceProxy > | Source |
int | Mode |
int | DefaultMode |
int | SourcePort |
![]() | |
char * | XMLName |
bool | IsOptional |
vtkSMDomainInternals * | Internals |
![]() | |
vtkWeakPointer< vtkSMSession > | Session |
domain used to restrict an vtkSMIntVectorProperty values to valid flat-index
for a vtkCompositeDataSet.
vtkSMCompositeTreeDomain can be added to a vtkSMIntVectorProperty. This domain requires a vtkSMInputProperty which is used to provide the input to the filter. This domain obtains data information from the input selected on the required input property and then decides the range for the flat-index. A flat index for a tree is obtained by performing a pre-order traversal of the tree eg. A ( B ( D, E), C (F, G)) becomes: [A,B,D,E,C,F,G], so flat-index of A is 0, while flat-index of C is 4.
vtkSMCompositeTreeDomain can be used in multiple modes.
mode="all"
. mode="leaves"
. mode="non-leaves"
in XML configuration.vtkSMCompositeTreeDomain also provides ability to set default value on the property. If mode is LEAVES, then the default value selected is the first non-null leaf node. If mode is ALL, the same behaviour for default value is possible by using default_mode="nonempty-leaf"
in XML. e.g.
Definition at line 65 of file vtkSMCompositeTreeDomain.h.
Definition at line 69 of file vtkSMCompositeTreeDomain.h.
anonymous enum |
Enumerator | |
---|---|
ALL | |
LEAVES | |
NON_LEAVES | |
NONE |
Definition at line 117 of file vtkSMCompositeTreeDomain.h.
Enumerator | |
---|---|
DEFAULT | |
NONEMPTY_LEAF |
Definition at line 125 of file vtkSMCompositeTreeDomain.h.
|
protected |
|
protected |
|
static |
|
virtual |
Reimplemented from vtkSMDomain.
|
static |
|
virtual |
Reimplemented from vtkSMDomain.
|
static |
void vtkSMCompositeTreeDomain::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
Called when the 'required-property' is modified.
The property must be a vtkSMInputProperty. This will obtain the composite data information for the input source and then determine the valid range for the flat-index.
Reimplemented from vtkSMDomain.
|
virtual |
Get the vtkPVDataInformation which provides the tree structure for the composite dataset.
vtkSMSourceProxy* vtkSMCompositeTreeDomain::GetSource | ( | ) |
Returns the source proxy whose data information is returned by GetInformation().
|
virtual |
Returns the port for the source proxy from which the data information is obtained by GetInformation().
|
inlinevirtual |
Is the (unchecked) value of the property in the domain? Overwritten by sub-classes.
Definition at line 105 of file vtkSMCompositeTreeDomain.h.
|
virtual |
Mode indicates if the property is interested in all nodes, leaves only or non-leaves only.
Can be configured in XML using the "mode" attribute. Values can be "all", "leaves", "non-leaves". Default is all nodes.
|
virtual |
Mode indicates if the property is interested in all nodes, leaves only or non-leaves only.
Can be configured in XML using the "mode" attribute. Values can be "all", "leaves", "non-leaves". Default is all nodes.
|
virtual |
DefaultMode controls how the default value for the property is set by SetDefaultValues().
DEFAULT implies the default value is picked based on the default strategy for the selected Mode. NONEMPTY_LEAF indicates that the first non-empty leaf node is set as the default value, if possible.
|
virtual |
DefaultMode controls how the default value for the property is set by SetDefaultValues().
DEFAULT implies the default value is picked based on the default strategy for the selected Mode. NONEMPTY_LEAF indicates that the first non-empty leaf node is set as the default value, if possible.
|
virtual |
A vtkSMProperty is often defined with a default value in the XML itself.
However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property. Returns 1 if the domain updated the property.
|
protectedvirtual |
Set the appropriate ivars from the xml element.
Should be overwritten by subclass if adding ivars.
Reimplemented from vtkSMDomain.
|
protected |
Internal implementation called by Update(vtkSMProperty*);.
|
protected |
|
protected |
|
protected |
Definition at line 168 of file vtkSMCompositeTreeDomain.h.
|
protected |
Definition at line 170 of file vtkSMCompositeTreeDomain.h.
|
protected |
Definition at line 171 of file vtkSMCompositeTreeDomain.h.
|
protected |
Definition at line 173 of file vtkSMCompositeTreeDomain.h.
|
protected |
Definition at line 174 of file vtkSMCompositeTreeDomain.h.
|
protected |
Definition at line 175 of file vtkSMCompositeTreeDomain.h.
|
protected |
Definition at line 176 of file vtkSMCompositeTreeDomain.h.