property representing pointer(s) to vtkObject(s) More...
#include <vtkSMProxyProperty.h>
Classes | |
class | vtkPPInternals |
This class is used by vtkSMProxyProperty to keep track of the proxies. More... | |
Public Types | |
typedef vtkSMProperty | 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) override |
virtual void | SetProxies (unsigned int numElements, vtkSMProxy *proxies[]) |
Sets the value of the property to the list of proxies specified. More... | |
bool | IsProxyAdded (vtkSMProxy *proxy) |
Returns if the given proxy is already added to the property. More... | |
virtual void | RemoveAllUncheckedProxies () |
Removes all unchecked proxies. More... | |
void | ClearUncheckedElements () override |
Use this method to clear unchecked values set of this property. More... | |
unsigned int | GetNumberOfProxies () |
Returns the number of proxies. More... | |
unsigned int | GetNumberOfUncheckedProxies () |
Returns the number of unchecked proxies. More... | |
vtkSMProxy * | GetProxy (unsigned int idx) |
Return a proxy. More... | |
vtkSMProxy * | GetUncheckedProxy (unsigned int idx) |
Return a proxy. More... | |
void | Copy (vtkSMProperty *src) override |
Copy all property values. More... | |
void | UpdateAllInputs () override |
Update all proxies referred by this property (if any). More... | |
void | ResetDefaultsToCurrent () |
Set all of the current proxies and ports to be the default ones. More... | |
bool | IsValueDefault () override |
Check if the current proxies and ports match the default ones, and that each proxy has default properties as well (which is recursive, since properties of proxy properties can also be proxy properties). More... | |
bool | IsValueDefaultNonRecursive () |
Check if the current proxies and ports match the default ones, but do not check that each proxy has default properties. More... | |
void | ResetToXMLDefaults () override |
For properties that support specifying defaults in XML configuration, this method will reset the property value to the default values specified in the XML. More... | |
virtual void | AddProxy (vtkSMProxy *proxy) |
Add/remove/set a proxy to the list of proxies. More... | |
virtual void | SetProxy (unsigned int idx, vtkSMProxy *proxy) |
Add/remove/set a proxy to the list of proxies. More... | |
virtual void | RemoveProxy (vtkSMProxy *proxy) |
Add/remove/set a proxy to the list of proxies. More... | |
virtual void | RemoveAllProxies () |
Add/remove/set a proxy to the list of proxies. More... | |
virtual void | AddUncheckedProxy (vtkSMProxy *proxy) |
Add an unchecked proxy. More... | |
virtual void | SetUncheckedProxy (unsigned int idx, vtkSMProxy *proxy) |
Add an unchecked proxy. More... | |
void | SetNumberOfProxies (unsigned int count) |
Set the number of proxies. More... | |
void | SetNumberOfUncheckedProxies (unsigned int count) |
Set the number of proxies. More... | |
![]() | |
int | IsInDomains () |
Returns true if all values are in all domains, false otherwise. More... | |
int | IsInDomains (vtkSMDomain **domain) |
Overload of IsInDomains() that provides a mechanism to return the first domain that fails the check. More... | |
void | UnRegister (vtkObjectBase *obj) override |
Overloaded to break the reference loop caused by the internal domain iterator. More... | |
vtkSMDomainIterator * | NewDomainIterator () |
Creates, initializes and returns a new domain iterator. More... | |
vtkSMDomain * | GetDomain (const char *name) |
Returns a domain give a name. More... | |
vtkSMDomain * | FindDomain (const char *classname) |
Returns the first domain which is of the specified type. More... | |
template<class DomainType > | |
DomainType * | FindDomain () |
Same as FindDomain(classname), except the classname is deduced from the type. More... | |
unsigned int | GetNumberOfDomains () |
Returns the number of domains this property has. More... | |
void | AddDomain (const char *name, vtkSMDomain *dom) |
Properties can have one or more domains. More... | |
virtual void | AddLinkedProperty (vtkSMProperty *targetProperty) |
Add a link to a property whose value should be synchronized with this property value. More... | |
virtual void | RemoveLinkedProperty (vtkSMProperty *targetProperty) |
Remove a link to a property added with AddLinkedProperty() More... | |
virtual void | RemoveFromSourceLink () |
Remove a link from the source property. More... | |
void | ResetToDefault () |
Simply calls this->ResetToDomainDefaults() and if that returns false, calls this->ResetToXMLDefaults(). More... | |
virtual bool | ResetToDomainDefaults (bool use_unchecked_values=false) |
Iterates over all domains and call SetDefaultValues() on each domain until the first one returns true i.e. More... | |
bool | ResetToSettings (double priority) |
Reset property value with settings. More... | |
vtkSMProxy * | GetParent () |
Get the proxy to which this property belongs. More... | |
virtual bool | IsStateIgnored () |
bool | HasDomainsWithRequiredProperties () |
Returns true if the property has a domain with required properties. More... | |
virtual void | SetCommand (const char *) |
The command name used to set the value on the server object. More... | |
virtual char * | GetCommand () |
The command name used to set the value on the server object. More... | |
virtual void | SetImmediateUpdate (int) |
If ImmediateUpdate is true, the value of the property will be pushed to the server as soon as it is modified. More... | |
virtual int | GetImmediateUpdate () |
If ImmediateUpdate is true, the value of the property will be pushed to the server as soon as it is modified. More... | |
virtual int | GetInformationOnly () |
Is InformationOnly is set to true, this property is used to get information from server instead of setting values. More... | |
virtual int | GetIgnoreSynchronization () |
If IgnoreSynchronization is set to true, this property is used to prevent that property from being updated when changed remotely by another collaborative client. More... | |
virtual vtkSMProperty * | GetInformationProperty () |
Get the associated information property. More... | |
virtual void | SetAnimateable (int) |
Get/Set if the property is animateable. More... | |
virtual int | GetAnimateable () |
Get/Set if the property is animateable. More... | |
virtual void | SetIsInternal (int) |
Get/Set if the property is internal to server manager. More... | |
virtual int | GetIsInternal () |
Get/Set if the property is internal to server manager. More... | |
virtual void | SetNoCustomDefault (int) |
Set/Get whether the property should ignore custom default settings. More... | |
virtual int | GetNoCustomDefault () |
Set/Get whether the property should ignore custom default settings. More... | |
virtual void | SetPanelVisibility (const char *) |
Set/Get the panel visibility for the property. More... | |
virtual char * | GetPanelVisibility () |
Set/Get the panel visibility for the property. More... | |
virtual void | SetPanelVisibilityDefaultForRepresentation (const char *) |
Set/Get the panel visibility to default if the current representation type matches representation . More... | |
virtual char * | GetPanelVisibilityDefaultForRepresentation () |
Set/Get the panel visibility to default if the current representation type matches representation . More... | |
virtual void | SetPanelWidget (const char *) |
Set/Get the name of the custom panel widget to use for the property. More... | |
virtual char * | GetPanelWidget () |
Set/Get the name of the custom panel widget to use for the property. More... | |
virtual void | SetDisableSubTrace (const char *) |
Set/Get the tracing of sub property of this property. More... | |
virtual char * | GetDisableSubTrace () |
Set/Get the tracing of sub property of this property. More... | |
virtual vtkSMDocumentation * | GetDocumentation () |
Returns the documentation for this proxy. More... | |
virtual char * | GetXMLLabel () |
The label assigned by the xml parser. More... | |
virtual char * | GetXMLName () |
The name assigned by the xml parser. More... | |
virtual int | GetRepeatable () |
If repeatable, a property can have 1 or more values of the same kind. More... | |
virtual vtkPVXMLElement * | GetHints () |
The server manager configuration XML may define <Hints/> element for a property. More... | |
void | SetHints (vtkPVXMLElement *hints) |
The server manager configuration XML may define <Hints/> element for a property. More... | |
void | Modified () override |
Overridden to support blocking of modified events. More... | |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
virtual void | DebugOff () |
bool | GetDebug () |
void | SetDebug (bool debugFlag) |
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) |
vtkCommand * | GetCommand (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) |
vtkCommand * | GetCommand (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) |
![]() | |
const char * | GetClassName () const |
virtual void | Delete () |
virtual void | FastDelete () |
void | Print (ostream &os) |
virtual void | Register (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 vtkSMProxyProperty * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMProxyProperty * | SafeDownCast (vtkObject *o) |
static void | EnableProxyCreation () |
When we load ProxyManager state we want Proxy/InputProperty to be able to create the corresponding missing proxy. More... | |
static void | DisableProxyCreation () |
When we load ProxyManager state we want Proxy/InputProperty to be able to create the corresponding missing proxy. More... | |
static bool | CanCreateProxy () |
When we load ProxyManager state we want Proxy/InputProperty to be able to create the corresponding missing proxy. More... | |
![]() | |
static vtkSMProperty * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMProperty * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkSMObject * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMObject * | SafeDownCast (vtkObject *o) |
static std::string | CreatePrettyLabel (const std::string &name) |
Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More... | |
![]() | |
static vtkObject * | New () |
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 vtkTypeBool | IsTypeOf (const char *name) |
static vtkObjectBase * | New () |
static vtkObjectBase * | New () |
Protected Member Functions | |
vtkSMProxyProperty () | |
~vtkSMProxyProperty () override | |
void | WriteTo (vtkSMMessage *msg) override |
Let the property write its content into the stream. More... | |
void | ReadFrom (const vtkSMMessage *msg, int msg_offset, vtkSMProxyLocator *) override |
Let the property read and set its content from the stream. More... | |
int | ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element) override |
Set the appropriate ivars from the xml element. More... | |
void | SaveStateValues (vtkPVXMLElement *propertyElement) override |
Generic method used to generate XML state. More... | |
virtual vtkPVXMLElement * | AddProxyElementState (vtkPVXMLElement *prop, unsigned int idx) |
Fill state property/proxy XML element with proxy info. More... | |
int | LoadState (vtkPVXMLElement *element, vtkSMProxyLocator *loader) override |
Updates state from an XML element. More... | |
void | OnUpdateDataEvent () |
Called when a producer fires the vtkCommand::UpdateDataEvent. More... | |
![]() | |
vtkSMProperty () | |
~vtkSMProperty () override | |
virtual void | ReadFrom (const vtkSMMessage *, int vtkNotUsed(message_offset), vtkSMProxyLocator *) |
Let the property read and set its content from the stream. More... | |
vtkSMProperty * | NewProperty (const char *name) |
Internal. More... | |
void | AddDependent (vtkSMDomain *dom) |
Internal. More... | |
void | RemoveAllDependents () |
Removes all dependents. More... | |
void | UpdateDomains () |
Calls Update() on all domains contained by the property as well as all dependent domains. More... | |
virtual void | SaveState (vtkPVXMLElement *parent, const char *property_name, const char *uid, int saveDomains=1) |
Save the property state in XML. More... | |
virtual void | SaveDomainState (vtkPVXMLElement *propertyElement, const char *uid) |
Save property domain. More... | |
virtual void | SetXMLLabel (const char *) |
virtual void | SetInformationOnly (int) |
virtual void | SetIgnoreSynchronization (int) |
void | SetInformationProperty (vtkSMProperty *ip) |
void | SetDocumentation (vtkSMDocumentation *) |
void | SetParent (vtkSMProxy *proxy) |
virtual void | SetStateIgnored (bool) |
virtual void | StateIgnoredOn () |
virtual void | StateIgnoredOff () |
virtual void | SetXMLName (const char *) |
The name assigned by the xml parser. More... | |
bool | SetBlockModifiedEvents (bool block) |
Block/unblock modified events, returns the current state of the block flag. More... | |
virtual bool | GetPendingModifiedEvents () |
Returns if any modified evetns are pending. More... | |
![]() | |
vtkSMObject () | |
~vtkSMObject () override | |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkPPInternals * | PPInternals |
![]() | |
vtkPVXMLElement * | Hints |
char * | Command |
vtkSMPropertyInternals * | PInternals |
int | ImmediateUpdate |
int | Animateable |
int | IsInternal |
int | NoCustomDefault |
char * | XMLName |
char * | XMLLabel |
char * | PanelVisibility |
char * | PanelVisibilityDefaultForRepresentation |
char * | PanelWidget |
char * | DisableSubTrace |
vtkSMDomainIterator * | DomainIterator |
int | InformationOnly |
int | IgnoreSynchronization |
vtkSMInformationHelper * | InformationHelper |
vtkSMProperty * | InformationProperty |
vtkSMDocumentation * | Documentation |
int | Repeatable |
vtkWeakPointer< vtkSMProxy > | Proxy |
bool | StateIgnored |
vtkSMPropertyLink * | Links |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Static Protected Attributes | |
static bool | CreateProxyAllowed |
Friends | |
class | vtkSMProxy |
class | vtkPPInternals |
property representing pointer(s) to vtkObject(s)
vtkSMProxyProperty is a concrete sub-class of vtkSMProperty representing pointer(s) to vtkObject(s) (through vtkSMProxy).
vtkSMProperty::UpdateDomains() is called by vtkSMProperty itself whenever its unchecked values are modified. In case of proxy-properties, the dependent domains typically tend to depend on the data information provided by the source-proxies added to the property. Thus, to ensure that the domains get updated if the data information changes, vtkSMProxyProperty ensures that vtkSMProperty::UpdateDomains() is called whenever any of the added proxies fires the vtkCommand::UpdateDataEvent (which is fired whenever the pipeline us updated through the ServerManager indicating that the data-information last used may have been invalidated).
Besides the standard set of attributes, the following XML attributes are supported:
command
every time the property value is pushed e.g. RemoveAllRepresentations. If property can take multiple values then the command
is called for for each of the values after the clean command for every push. Definition at line 57 of file vtkSMProxyProperty.h.
Definition at line 73 of file vtkSMProxyProperty.h.
|
protected |
|
overrideprotected |
|
static |
When we load ProxyManager state we want Proxy/InputProperty to be able to create the corresponding missing proxy.
Although when the goal is to load a state on any standard proxy, we do not want that proxy property be able to create new proxy based on some previous state.
|
static |
When we load ProxyManager state we want Proxy/InputProperty to be able to create the corresponding missing proxy.
Although when the goal is to load a state on any standard proxy, we do not want that proxy property be able to create new proxy based on some previous state.
|
static |
When we load ProxyManager state we want Proxy/InputProperty to be able to create the corresponding missing proxy.
Although when the goal is to load a state on any standard proxy, we do not want that proxy property be able to create new proxy based on some previous state.
|
static |
|
virtual |
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMInputProperty.
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMInputProperty.
|
static |
|
overridevirtual |
Reimplemented from vtkSMProperty.
|
virtual |
Add/remove/set a proxy to the list of proxies.
For SetProxy, the property automatically resizes to accommodate the index specified.
|
virtual |
Add/remove/set a proxy to the list of proxies.
For SetProxy, the property automatically resizes to accommodate the index specified.
|
virtual |
Add/remove/set a proxy to the list of proxies.
For SetProxy, the property automatically resizes to accommodate the index specified.
|
virtual |
Add/remove/set a proxy to the list of proxies.
For SetProxy, the property automatically resizes to accommodate the index specified.
|
virtual |
Sets the value of the property to the list of proxies specified.
bool vtkSMProxyProperty::IsProxyAdded | ( | vtkSMProxy * | proxy | ) |
Returns if the given proxy is already added to the property.
|
virtual |
Add an unchecked proxy.
Does not modify the property. Unchecked proxies are used by domains when verifying whether a value is acceptable. To check if a value is in the domains, you can do the following:
* - RemoveAllUncheckedProxies() * - AddUncheckedProxy(proxy) * - IsInDomains() *
|
virtual |
Add an unchecked proxy.
Does not modify the property. Unchecked proxies are used by domains when verifying whether a value is acceptable. To check if a value is in the domains, you can do the following:
* - RemoveAllUncheckedProxies() * - AddUncheckedProxy(proxy) * - IsInDomains() *
|
virtual |
Removes all unchecked proxies.
|
inlineoverridevirtual |
Use this method to clear unchecked values set of this property.
Reimplemented from vtkSMProperty.
Definition at line 117 of file vtkSMProxyProperty.h.
unsigned int vtkSMProxyProperty::GetNumberOfProxies | ( | ) |
Returns the number of proxies.
unsigned int vtkSMProxyProperty::GetNumberOfUncheckedProxies | ( | ) |
Returns the number of unchecked proxies.
void vtkSMProxyProperty::SetNumberOfProxies | ( | unsigned int | count | ) |
Set the number of proxies.
void vtkSMProxyProperty::SetNumberOfUncheckedProxies | ( | unsigned int | count | ) |
Set the number of proxies.
vtkSMProxy* vtkSMProxyProperty::GetProxy | ( | unsigned int | idx | ) |
Return a proxy.
No bounds check is performed.
vtkSMProxy* vtkSMProxyProperty::GetUncheckedProxy | ( | unsigned int | idx | ) |
Return a proxy.
No bounds check is performed.
|
overridevirtual |
Copy all property values.
This method behaves differently for properties with vtkSMProxyListDomain and those without it. If the property has a vtkSMProxyListDomain, then the property is acting as an enumeration, giving user ability to pick one of the available proxies in the domain, hence a Copy
request, will find an equivalent proxy on the target's domain and set that as the value of the target property.
Reimplemented from vtkSMProperty.
|
overridevirtual |
Update all proxies referred by this property (if any).
Reimplemented from vtkSMProperty.
void vtkSMProxyProperty::ResetDefaultsToCurrent | ( | ) |
Set all of the current proxies and ports to be the default ones.
|
overridevirtual |
Check if the current proxies and ports match the default ones, and that each proxy has default properties as well (which is recursive, since properties of proxy properties can also be proxy properties).
Note: internal properties are ignored. This is so that properties such as Input
do not affect IsValueDefault()
.
Reimplemented from vtkSMProperty.
bool vtkSMProxyProperty::IsValueDefaultNonRecursive | ( | ) |
Check if the current proxies and ports match the default ones, but do not check that each proxy has default properties.
This is essentially a non-recursive version of IsValueDefault()
.
|
overridevirtual |
For properties that support specifying defaults in XML configuration, this method will reset the property value to the default values specified in the XML.
Simply clears the property.
Reimplemented from vtkSMProperty.
|
overrideprotectedvirtual |
Let the property write its content into the stream.
Reimplemented from vtkSMProperty.
|
overrideprotected |
Let the property read and set its content from the stream.
|
overrideprotectedvirtual |
Set the appropriate ivars from the xml element.
Should be overwritten by subclass if adding ivars.
Reimplemented from vtkSMProperty.
|
overrideprotectedvirtual |
Generic method used to generate XML state.
Reimplemented from vtkSMProperty.
|
protectedvirtual |
Fill state property/proxy XML element with proxy info.
Return the created proxy XML element that has been added as a child in the property definition. If prop == nullptr, you must Delete yourself the result otherwise prop is olding a reference to the proxy element
Reimplemented in vtkSMInputProperty.
|
overrideprotectedvirtual |
|
inlineprotected |
Called when a producer fires the vtkCommand::UpdateDataEvent.
We update all dependent domains since the data-information may have changed.
Definition at line 236 of file vtkSMProxyProperty.h.
|
friend |
Definition at line 207 of file vtkSMProxyProperty.h.
|
friend |
Definition at line 242 of file vtkSMProxyProperty.h.
|
staticprotected |
Definition at line 240 of file vtkSMProxyProperty.h.
|
protected |
Definition at line 244 of file vtkSMProxyProperty.h.