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

a map property storing double values More...

#include <vtkSMDoubleMapProperty.h>

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

Public Types

typedef vtkSMMapProperty Superclass
 
- Public Types inherited from vtkSMMapProperty
typedef vtkSMProperty Superclass
 
- Public Types inherited from vtkSMProperty
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 SetNumberOfComponents (unsigned int components)
 Sets the number of components. More...
 
unsigned int GetNumberOfComponents ()
 Returns the number of components. More...
 
void SetElement (vtkIdType index, double value)
 Sets the element at index to value. More...
 
void SetElements (vtkIdType index, const double *values)
 Sets the elements at index to values. More...
 
void SetElements (vtkIdType index, const double *values, unsigned int numValues)
 Sets the elements at index to values. More...
 
void SetElementComponent (vtkIdType index, unsigned int component, double value)
 Sets the component at index to value. More...
 
double GetElement (vtkIdType index)
 Returns the element at index. More...
 
doubleGetElements (vtkIdType index)
 Returns the elements at index. More...
 
double GetElementComponent (vtkIdType index, vtkIdType component)
 Returns the element component at index. More...
 
void RemoveElement (vtkIdType index)
 Removes the element at index. More...
 
vtkIdType GetNumberOfElements () override
 Returns the number of elements. More...
 
bool HasElement (vtkIdType index)
 Returns true if the property has an element with the given index. More...
 
void ClearElements ()
 Clears all of the elements from the property. More...
 
VTK_NEWINSTANCE vtkSMDoubleMapPropertyIteratorNewIterator ()
 Returns a new iterator for the map. More...
 
void * GetMapPointer ()
 
void Copy (vtkSMProperty *src) override
 Copy all property values. 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...
 
- Public Member Functions inherited from vtkSMMapProperty
void PrintSelf (ostream &os, vtkIndent indent) override
 
bool IsValueDefault () override
 Returns true if the current value is the same as the default value. More...
 
void Copy (vtkSMProperty *src) override
 Copy all property values. More...
 
- Public Member Functions inherited from vtkSMProperty
void PrintSelf (ostream &os, vtkIndent indent) override
 
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...
 
vtkSMDomainIteratorNewDomainIterator ()
 Creates, initializes and returns a new domain iterator. More...
 
vtkSMDomainGetDomain (const char *name)
 Returns a domain give a name. More...
 
vtkSMDomainFindDomain (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...
 
vtkSMProxyGetParent ()
 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 ClearUncheckedElements ()
 Use this method to clear unchecked values set of this property. 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 vtkSMPropertyGetInformationProperty ()
 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)
 Sets whether the property should ignore custom default settings. More...
 
virtual int GetNoCustomDefault ()
 Gets whether the property should ignore custom default settings. More...
 
virtual void SetPanelVisibility (const char *)
 Sets the panel visibility for the property. More...
 
virtual char * GetPanelVisibility ()
 Returns the panel visibility for the property. More...
 
virtual void SetPanelVisibilityDefaultForRepresentation (const char *)
 Sets the panel visibility to default if the current representation type matches representation. More...
 
virtual char * GetPanelVisibilityDefaultForRepresentation ()
 Returns which representation type the property will be shown by default for. More...
 
virtual void SetPanelWidget (const char *)
 Sets the name of the custom panel widget to use for the property. More...
 
virtual char * GetPanelWidget ()
 Returns name of the panel widget for the property. More...
 
virtual void SetDisableSubTrace (const char *)
 Sets the tracing of sub property of this property. More...
 
virtual char * GetDisableSubTrace ()
 Returns the tracing state of the properties of this property. More...
 
virtual vtkSMDocumentationGetDocumentation ()
 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 vtkPVXMLElementGetHints ()
 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...
 
- Public Member Functions inherited from vtkObject
 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)
 
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)
 
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 vtkSMDoubleMapPropertyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMDoubleMapPropertySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMMapProperty
static int IsTypeOf (const char *type)
 
static vtkSMMapPropertySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMProperty
static vtkSMPropertyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMPropertySafeDownCast (vtkObject *o)
 
static const char * CreateNewPrettyLabel (const char *name)
 Given the string, this method will create and set a well-formated string as XMLLabel and returns it. More...
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (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 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

 vtkSMDoubleMapProperty ()
 
 ~vtkSMDoubleMapProperty () override
 
void WriteTo (vtkSMMessage *msg) override
 Let the property write its content into the stream. More...
 
void ReadFrom (const vtkSMMessage *message, int message_offset, vtkSMProxyLocator *locator) override
 
int ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element) override
 Set the appropriate ivars from the xml element. More...
 
void SaveStateValues (vtkPVXMLElement *propertyElement) override
 This method must be overridden by concrete class in order to save the real property data. More...
 
int LoadState (vtkPVXMLElement *element, vtkSMProxyLocator *loader) override
 Updates state from an XML element. More...
 
- Protected Member Functions inherited from vtkSMMapProperty
 vtkSMMapProperty ()
 
 ~vtkSMMapProperty () override
 
int LoadState (vtkPVXMLElement *element, vtkSMProxyLocator *loader) override
 Updates state from an XML element. More...
 
int ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element) override
 Set the appropriate ivars from the xml element. More...
 
- Protected Member Functions inherited from vtkSMProperty
 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...
 
virtual void UpdateAllInputs ()
 Update all proxies referred by this property (if any). More...
 
vtkSMPropertyNewProperty (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...
 
- 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMProperty
vtkPVXMLElementHints
 
char * Command
 
vtkSMPropertyInternalsPInternals
 
int ImmediateUpdate
 
int Animateable
 
int IsInternal
 
int NoCustomDefault
 
char * XMLName
 
char * XMLLabel
 
char * PanelVisibility
 
char * PanelVisibilityDefaultForRepresentation
 
char * PanelWidget
 
char * DisableSubTrace
 
vtkSMDomainIteratorDomainIterator
 
int InformationOnly
 
int IgnoreSynchronization
 
vtkSMInformationHelper * InformationHelper
 
vtkSMPropertyInformationProperty
 
vtkSMDocumentationDocumentation
 
int Repeatable
 
vtkWeakPointer< vtkSMProxyProxy
 
bool StateIgnored
 
vtkSMPropertyLinkLinks
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a map property storing double values

vtkSMDoubleMapProperty stores a map of vtkIdType keys to double values.

Definition at line 19 of file vtkSMDoubleMapProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 23 of file vtkSMDoubleMapProperty.h.

Constructor & Destructor Documentation

◆ vtkSMDoubleMapProperty()

vtkSMDoubleMapProperty::vtkSMDoubleMapProperty ( )
protected

◆ ~vtkSMDoubleMapProperty()

vtkSMDoubleMapProperty::~vtkSMDoubleMapProperty ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMDoubleMapProperty* vtkSMDoubleMapProperty::New ( )
static

◆ GetClassName()

virtual const char* vtkSMDoubleMapProperty::GetClassName ( )
virtual

Reimplemented from vtkSMMapProperty.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMMapProperty.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkObject.

◆ SetNumberOfComponents()

void vtkSMDoubleMapProperty::SetNumberOfComponents ( unsigned int  components)

Sets the number of components.

◆ GetNumberOfComponents()

unsigned int vtkSMDoubleMapProperty::GetNumberOfComponents ( )

Returns the number of components.

◆ SetElement()

void vtkSMDoubleMapProperty::SetElement ( vtkIdType  index,
double  value 
)

Sets the element at index to value.

◆ SetElements() [1/2]

void vtkSMDoubleMapProperty::SetElements ( vtkIdType  index,
const double values 
)

Sets the elements at index to values.

◆ SetElements() [2/2]

void vtkSMDoubleMapProperty::SetElements ( vtkIdType  index,
const double values,
unsigned int  numValues 
)

Sets the elements at index to values.

◆ SetElementComponent()

void vtkSMDoubleMapProperty::SetElementComponent ( vtkIdType  index,
unsigned int  component,
double  value 
)

Sets the component at index to value.

◆ GetElement()

double vtkSMDoubleMapProperty::GetElement ( vtkIdType  index)

Returns the element at index.

◆ GetElements()

double* vtkSMDoubleMapProperty::GetElements ( vtkIdType  index)

Returns the elements at index.

◆ GetElementComponent()

double vtkSMDoubleMapProperty::GetElementComponent ( vtkIdType  index,
vtkIdType  component 
)

Returns the element component at index.

◆ RemoveElement()

void vtkSMDoubleMapProperty::RemoveElement ( vtkIdType  index)

Removes the element at index.

◆ GetNumberOfElements()

vtkIdType vtkSMDoubleMapProperty::GetNumberOfElements ( )
overridevirtual

Returns the number of elements.

Reimplemented from vtkSMMapProperty.

◆ HasElement()

bool vtkSMDoubleMapProperty::HasElement ( vtkIdType  index)

Returns true if the property has an element with the given index.

◆ ClearElements()

void vtkSMDoubleMapProperty::ClearElements ( )

Clears all of the elements from the property.

◆ NewIterator()

VTK_NEWINSTANCE vtkSMDoubleMapPropertyIterator* vtkSMDoubleMapProperty::NewIterator ( )

Returns a new iterator for the map.

◆ GetMapPointer()

void* vtkSMDoubleMapProperty::GetMapPointer ( )

◆ Copy()

void vtkSMDoubleMapProperty::Copy ( vtkSMProperty src)
overridevirtual

Copy all property values.

Reimplemented from vtkSMProperty.

◆ ResetToXMLDefaults()

void vtkSMDoubleMapProperty::ResetToXMLDefaults ( )
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.

Reimplemented from vtkSMProperty.

◆ WriteTo()

void vtkSMDoubleMapProperty::WriteTo ( vtkSMMessage msg)
overrideprotectedvirtual

Let the property write its content into the stream.

Reimplemented from vtkSMProperty.

◆ ReadFrom()

void vtkSMDoubleMapProperty::ReadFrom ( const vtkSMMessage message,
int  message_offset,
vtkSMProxyLocator locator 
)
overrideprotected

◆ ReadXMLAttributes()

int vtkSMDoubleMapProperty::ReadXMLAttributes ( vtkSMProxy parent,
vtkPVXMLElement element 
)
overrideprotectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMProperty.

◆ SaveStateValues()

void vtkSMDoubleMapProperty::SaveStateValues ( vtkPVXMLElement propertyElement)
overrideprotectedvirtual

This method must be overridden by concrete class in order to save the real property data.

Reimplemented from vtkSMProperty.

◆ LoadState()

int vtkSMDoubleMapProperty::LoadState ( vtkPVXMLElement element,
vtkSMProxyLocator loader 
)
overrideprotectedvirtual

Updates state from an XML element.

Returns 0 on failure.

Reimplemented from vtkSMProperty.


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