vtkPropertyDecorator subclass that can combine multiple decorators using boolean operations. More...

#include <vtkCompositePropertyDecorator.h>

Inheritance diagram for vtkCompositePropertyDecorator:

Collaboration diagram for vtkCompositePropertyDecorator:

[legend]

Public Types
typedef vtkPropertyDecorator	Superclass

using	DecoratorCreationFunction = std::function< vtkSmartPointer< vtkPropertyDecorator >(vtkPVXMLElement , vtkSMProxy )>

Public Types inherited from vtkPropertyDecorator
enum	{ VisibilityChangedEvent = vtkCommand::UserEvent + 1000, EnableStateChangedEvent = vtkCommand::UserEvent + 1001 }
	This event is fired whenever the decorator has determined that the panel may need a refresh since the state of the system has changed which would deem changes in the widget visibility or enable state. More...

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	Initialize (vtkPVXMLElement config, vtkSMProxy proxy) override
	Constructor. More...

bool	CanShow (bool show_advanced) const override
	Override this method to override the visibility of the widget in the panel. More...

bool	Enable () const override
	Override this method to override the enable state of the widget in the panel. More...

void	RegisterDecorator (DecoratorCreationFunction func)

Public Member Functions inherited from vtkPropertyDecorator
void	PrintSelf (ostream &os, vtkIndent indent) override

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)

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)

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 vtkCompositePropertyDecorator *	New ()

static int	IsTypeOf (const char *type)

static vtkCompositePropertyDecorator *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkPropertyDecorator
static vtkPropertyDecorator *	New ()

static int	IsTypeOf (const char *type)

static vtkPropertyDecorator *	SafeDownCast (vtkObject *o)

static vtkSmartPointer< vtkPropertyDecorator >	Create (vtkPVXMLElement xml, vtkSMProxy proxy)
	Creates a new decorator, given the xml config and the proxy containing the property For unsupported/unknown, implementations should simply return nullptr without raising any errors (or messages). More...

Static Public Member Functions inherited from vtkObject
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 Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkCompositePropertyDecorator ()

	~vtkCompositePropertyDecorator () override

Protected Member Functions inherited from vtkPropertyDecorator
	vtkPropertyDecorator ()

	~vtkPropertyDecorator () override

vtkPVXMLElement *	XML () const

vtkSMProxy *	Proxy () const

void	InvokeVisibilityChangedEvent ()

void	InvokeEnableStateChangedEvent ()

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 vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

vtkPropertyDecorator subclass that can combine multiple decorators using boolean operations.

vtkCompositePropertyDecorator helps combine multiple decorators using boolean operators as indicated in the example below.

<IntVectorProperty name="Expression1"
   number_of_elements="1"
   default_values="0">
   <BooleanDomain name="bool" />
   <Hints>
     <!-- Expression === { A and [B or (C and D)] } or E -->
     <PropertyWidgetDecorator type="CompositeDecorator">
       <Expression type="or">
         <Expression type="and">
           <PropertyWidgetDecorator type="GenericDecorator" mode="enabled_state" property="A"
                 value="1" />
           <Expression type="or">
             <PropertyWidgetDecorator type="GenericDecorator" mode="enabled_state" property="B"
                 value="1" />
             <Expression type="and">
               <PropertyWidgetDecorator type="GenericDecorator" mode="enabled_state" property="C"
                   value="1" />
               <PropertyWidgetDecorator type="GenericDecorator" mode="enabled_state" property="D"
                   value="1" />
             </Expression>
           </Expression>
         </Expression>
         <PropertyWidgetDecorator type="GenericDecorator" mode="enabled_state" property="E"
             value="1" />
       </Expression>
     </PropertyWidgetDecorator>
   </Hints>
</IntVectorProperty>

Definition at line 51 of file vtkCompositePropertyDecorator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPropertyDecorator vtkCompositePropertyDecorator::Superclass

Definition at line 56 of file vtkCompositePropertyDecorator.h.

◆ DecoratorCreationFunction

using vtkCompositePropertyDecorator::DecoratorCreationFunction = std::function<vtkSmartPointer<vtkPropertyDecorator>(vtkPVXMLElement*, vtkSMProxy*)>

Definition at line 78 of file vtkCompositePropertyDecorator.h.

Constructor & Destructor Documentation

◆ vtkCompositePropertyDecorator()

vtkCompositePropertyDecorator::vtkCompositePropertyDecorator ( )

protected

◆ ~vtkCompositePropertyDecorator()

vtkCompositePropertyDecorator::~vtkCompositePropertyDecorator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkCompositePropertyDecorator* vtkCompositePropertyDecorator::New ( )

static

◆ GetClassName()

virtual const char* vtkCompositePropertyDecorator::GetClassName ( )

virtual

Reimplemented from vtkPropertyDecorator.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkPropertyDecorator.

◆ SafeDownCast()

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

static

◆ PrintSelf()

void vtkCompositePropertyDecorator::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkObject.

◆ Initialize()

void vtkCompositePropertyDecorator::Initialize	(	vtkPVXMLElement *	xml,
		vtkSMProxy *	proxy
	)

overridevirtual

Constructor.

Parameters

xml	The XML element from the `<Hints/>` section for the proxy/property that resulted in the creation of the decorator. Decorators can be provided configuration parameters from the XML.
proxy	The proxy that owns the property of this decorator

Reimplemented from vtkPropertyDecorator.

◆ CanShow()

bool vtkCompositePropertyDecorator::CanShow ( bool show_advanced ) const

overridevirtual

Override this method to override the visibility of the widget in the panel.

This is called after the generic tests for advanced and text filtering are passed. Since there can be multiple decorators, the first decorator that returns 'false' wins. Default implementation returns true. Thus subclasses typically override this method only to force the widget invisible given the current state.

Reimplemented from vtkPropertyDecorator.

◆ Enable()

bool vtkCompositePropertyDecorator::Enable ( ) const

overridevirtual

Override this method to override the enable state of the widget in the panel.

This is called after the generic tests for advanced and text filtering are passed. Since there can be multiple decorators, the first decorator that returns 'false' wins. Default implementation returns true. Thus subclasses typically override this method only to force the widget disabled given the current state.

Reimplemented from vtkPropertyDecorator.

◆ RegisterDecorator()

void vtkCompositePropertyDecorator::RegisterDecorator ( DecoratorCreationFunction func )

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ApplicationComponents/vtkCompositePropertyDecorator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

◆ DecoratorCreationFunction

Constructor & Destructor Documentation

◆ vtkCompositePropertyDecorator()

◆ ~vtkCompositePropertyDecorator()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Initialize()

◆ CanShow()

◆ Enable()

◆ RegisterDecorator()