Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMProxyGroupDomain Class Reference

union of proxy groups More...

#include <vtkSMProxyGroupDomain.h>

Inheritance diagram for vtkSMProxyGroupDomain:
Inheritance graph
[legend]
Collaboration diagram for vtkSMProxyGroupDomain:
Collaboration graph
[legend]

Public Types

typedef vtkSMDomain Superclass
 
- Public Types inherited from vtkSMDomain
enum  IsInDomainReturnCodes { NOT_APPLICABLE = -1, NOT_IN_DOMAIN = 0, IN_DOMAIN = 1 }
 Return values for IsInDomain calls. More...
 
typedef vtkSMSessionObject Superclass
 
- Public Types inherited from vtkSMSessionObject
typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void AddGroup (const char *group)
 Add a group to the domain. More...
 
int IsInDomain (vtkSMProperty *property) override
 Returns true if the value of the property 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...
 
vtkSMProxyGetProxy (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...
 
vtkSMProxyGetProxy (unsigned int idx)
 Given an index, returns a proxy. More...
 
const char * GetProxyName (vtkSMProxy *proxy)
 Returns the name (in the group) of a proxy. More...
 
- Public Member Functions inherited from vtkSMDomain
virtual int IsInDomain (vtkSMProperty *vtkNotUsed(property))
 Is the (unchecked) value of the property in the domain? Overwritten by sub-classes. More...
 
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...
 
vtkSMPropertyGetProperty ()
 Provides access to the vtkSMProperty on which this domain is hooked up. More...
 
virtual unsigned int GetNumberOfInputConnections (const char *function)
 Helper method to get the number of input connections hence the number of available vtkPVDataInformation from input proxy connected to the required property with the given function. More...
 
vtkSMPropertyGetRequiredProperty (const char *function)
 Returns a given required property of the given function. More...
 
virtual char * GetXMLName ()
 Assigned by the XML parser. More...
 
virtual bool GetIsOptional ()
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
virtual vtkPVDataInformationGetInputDataInformation (const char *function, unsigned int index=0)
 Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...
 
virtual vtkPVDataInformationGetInputSubsetDataInformation (unsigned int compositeIndex, const char *function, unsigned int index=0)
 Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...
 
- Public Member Functions inherited from vtkSMSessionObject
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual void SetSession (vtkSMSession *)
 Get/Set the session on wihch this object exists. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int 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)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkSMProxyGroupDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMProxyGroupDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDomain
static vtkSMDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMProxyGroupDomain ()
 
 ~vtkSMProxyGroupDomain () override
 
int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) override
 Set the appropriate ivars from the xml element. More...
 
- Protected Member Functions inherited from vtkSMDomain
 vtkSMDomain ()
 
 ~vtkSMDomain () override
 
virtual int LoadState (vtkPVXMLElement *vtkNotUsed(domainElement), vtkSMProxyLocator *vtkNotUsed(loader))
 Load the state of the domain from the XML. 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...
 
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...
 
- Protected Member Functions inherited from vtkSMSessionObject
 vtkSMSessionObject ()
 
 ~vtkSMSessionObject () override
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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 &)
 

Protected Attributes

vtkSMProxyGroupDomainInternals * PGInternals
 
- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 Identifies the session id to which this object is related. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

union of proxy groups

The proxy group domain consists of all proxies in a list of groups. This domain is commonly used together with vtkSMProxyproperty 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 vtkSMProxyproperty

Definition at line 40 of file vtkSMProxyGroupDomain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkSMProxyGroupDomain.h.

Constructor & Destructor Documentation

◆ vtkSMProxyGroupDomain()

vtkSMProxyGroupDomain::vtkSMProxyGroupDomain ( )
protected

◆ ~vtkSMProxyGroupDomain()

vtkSMProxyGroupDomain::~vtkSMProxyGroupDomain ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMProxyGroupDomain* vtkSMProxyGroupDomain::New ( )
static

◆ GetClassName()

virtual const char* vtkSMProxyGroupDomain::GetClassName ( )
virtual

Reimplemented from vtkSMDomain.

◆ IsTypeOf()

static int vtkSMProxyGroupDomain::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkSMProxyGroupDomain::IsA ( const char *  type)
virtual

Reimplemented from vtkSMDomain.

◆ SafeDownCast()

static vtkSMProxyGroupDomain* vtkSMProxyGroupDomain::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

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

Reimplemented from vtkSMDomain.

◆ AddGroup()

void vtkSMProxyGroupDomain::AddGroup ( const char *  group)

Add a group to the domain.

The domain is the union of all groups.

◆ IsInDomain() [1/2]

int vtkSMProxyGroupDomain::IsInDomain ( vtkSMProperty property)
override

Returns true if the value of the property is in the domain.

The property has to be a vtkSMProxyproperty or a sub-class. All proxies pointed by the property have to be in the domain.

◆ IsInDomain() [2/2]

int vtkSMProxyGroupDomain::IsInDomain ( vtkSMProxy proxy)

Returns true if the proxy is in the domain.

◆ GetNumberOfGroups()

unsigned int vtkSMProxyGroupDomain::GetNumberOfGroups ( )

Returns the number of groups.

◆ GetGroup()

const char* vtkSMProxyGroupDomain::GetGroup ( unsigned int  idx)

Returns group with give id.

Does not perform bounds check.

◆ GetNumberOfProxies()

unsigned int vtkSMProxyGroupDomain::GetNumberOfProxies ( )

Returns the total number of proxies in the domain.

◆ GetProxy() [1/2]

vtkSMProxy* vtkSMProxyGroupDomain::GetProxy ( const char *  name)

Given a name, returns a proxy.

◆ GetProxyName() [1/2]

const char* vtkSMProxyGroupDomain::GetProxyName ( unsigned int  idx)

Returns the name (in the group) of a proxy.

◆ GetProxy() [2/2]

vtkSMProxy* vtkSMProxyGroupDomain::GetProxy ( unsigned int  idx)

Given an index, returns a proxy.

◆ GetProxyName() [2/2]

const char* vtkSMProxyGroupDomain::GetProxyName ( vtkSMProxy proxy)

Returns the name (in the group) of a proxy.

◆ ReadXMLAttributes()

int vtkSMProxyGroupDomain::ReadXMLAttributes ( vtkSMProperty prop,
vtkPVXMLElement element 
)
overrideprotectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMDomain.

Member Data Documentation

◆ PGInternals

vtkSMProxyGroupDomainInternals* vtkSMProxyGroupDomain::PGInternals
protected

Definition at line 110 of file vtkSMProxyGroupDomain.h.


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