ParaView
|
union of proxy groups More...
#include <vtkSMProxyGroupDomain.h>
Public Types | |
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) |
void | AddGroup (const char *group) |
Add a group to the domain. More... | |
virtual int | IsInDomain (vtkSMProperty *property) |
Returns true if the value of the propery is in the domain. More... | |
int | IsInDomain (vtkSMProxy *proxy) |
Returns true if the proxy is in the domain. More... | |
unsigned int | GetNumberOfGroups () |
Returns the number of groups. More... | |
const char * | GetGroup (unsigned int idx) |
Returns group with give id. More... | |
unsigned int | GetNumberOfProxies () |
Returns the total number of proxies in the domain. More... | |
vtkSMProxy * | GetProxy (const char *name) |
Given a name, returns a proxy. More... | |
const char * | GetProxyName (unsigned int idx) |
Returns the name (in the group) of a proxy. More... | |
const char * | GetProxyName (vtkSMProxy *proxy) |
Returns the name (in the group) of a proxy. More... | |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual void | Update (vtkSMProperty *requestingProperty) |
Update self based on the "unchecked" values of all required properties. 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 vtkSMProxyGroupDomain * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMProxyGroupDomain * | 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 | |
vtkSMProxyGroupDomain () | |
~vtkSMProxyGroupDomain () | |
virtual int | ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) |
Set the appropriate ivars from the xml element. More... | |
![]() | |
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 | |
vtkSMProxyGroupDomainInternals * | PGInternals |
![]() | |
char * | XMLName |
bool | IsOptional |
vtkSMDomainInternals * | Internals |
![]() | |
vtkWeakPointer< vtkSMSession > | Session |
union of proxy groups
The proxy group domain consists of all proxies in a list of groups. This domain is commonly used together with vtkSMProxyPropery Valid XML elements are:
* * <Group name=""> where name is the groupname used by the proxy * manager to refer to a group of proxies. *
// .SECTION See Also vtkSMDomain vtkSMProxyPropery
Definition at line 40 of file vtkSMProxyGroupDomain.h.
Definition at line 44 of file vtkSMProxyGroupDomain.h.
|
protected |
|
protected |
|
static |
|
virtual |
Reimplemented from vtkSMDomain.
|
static |
|
virtual |
Reimplemented from vtkSMDomain.
|
static |
void vtkSMProxyGroupDomain::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
void vtkSMProxyGroupDomain::AddGroup | ( | const char * | group | ) |
Add a group to the domain.
The domain is the union of all groups.
|
virtual |
Returns true if the value of the propery is in the domain.
The propery has to be a vtkSMProxyPropery or a sub-class. All proxies pointed by the property have to be in the domain.
Implements vtkSMDomain.
int vtkSMProxyGroupDomain::IsInDomain | ( | vtkSMProxy * | proxy | ) |
Returns true if the proxy is in the domain.
unsigned int vtkSMProxyGroupDomain::GetNumberOfGroups | ( | ) |
Returns the number of groups.
const char* vtkSMProxyGroupDomain::GetGroup | ( | unsigned int | idx | ) |
Returns group with give id.
Does not perform bounds check.
unsigned int vtkSMProxyGroupDomain::GetNumberOfProxies | ( | ) |
Returns the total number of proxies in the domain.
vtkSMProxy* vtkSMProxyGroupDomain::GetProxy | ( | const char * | name | ) |
Given a name, returns a proxy.
const char* vtkSMProxyGroupDomain::GetProxyName | ( | unsigned int | idx | ) |
Returns the name (in the group) of a proxy.
const char* vtkSMProxyGroupDomain::GetProxyName | ( | vtkSMProxy * | proxy | ) |
Returns the name (in the group) of a proxy.
|
protectedvirtual |
Set the appropriate ivars from the xml element.
Should be overwritten by subclass if adding ivars.
Reimplemented from vtkSMDomain.
|
protected |
Definition at line 105 of file vtkSMProxyGroupDomain.h.