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

is a helper for to work with SILs. More...

#include <vtkSMSILModel.h>

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

Public Types

enum  CheckState { UNCHECKED = 0, PARTIAL = 1, CHECKED = 2 }
 
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)
 
int GetNumberOfChildren (vtkIdType vertexid)
 Returns the number of children for the given vertex. More...
 
vtkIdType GetChildVertex (vtkIdType parentid, int child_index)
 Returns the vertex id for the n-th child where n=child_index. More...
 
vtkIdType GetParentVertex (vtkIdType parent)
 Returns the parent vertex i.e. More...
 
const char * GetName (vtkIdType vertex)
 Get the name for the vertex. More...
 
int GetCheckStatus (vtkIdType vertex)
 Get the check state for a vertex. More...
 
void UpdatePropertyValue (vtkSMStringVectorProperty *)
 Updates the property using the check states maintained by the model. More...
 
void UpdateStateFromProperty (vtkSMStringVectorProperty *)
 Updates the check states maintained internally by the model using the status from the property. More...
 
vtkIdType FindVertex (const char *name)
 Locate a vertex with the given name. More...
 
void GetLeaves (std::set< vtkIdType > &leaves, vtkIdType root, bool traverse_cross_edges)
 
void Initialize (vtkGraph *sil)
 Initialize the model using a SIL. More...
 
virtual vtkGraph * GetSIL ()
 Initialize the model using a SIL. More...
 
void Initialize (vtkSMProxy *, vtkSMStringVectorProperty *)
 Initialize the model using a proxy and its property. More...
 
virtual vtkSMProxyGetProxy ()
 Initialize the model using a proxy and its property. More...
 
virtual vtkSMStringVectorPropertyGetProperty ()
 Initialize the model using a proxy and its property. More...
 
bool SetCheckState (vtkIdType vertex, int status)
 Set the check state for a vertex. More...
 
bool SetCheckState (const char *name, int status)
 Set the check state for a vertex. More...
 
void CheckAll ()
 Convenience methods to check/uncheck all items. More...
 
void UncheckAll ()
 Convenience methods to check/uncheck all items. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMSILModelNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSILModelSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMSILModel ()
 
virtual ~vtkSMSILModel ()
 
void UpdateProperty ()
 
void OnPropertyModified ()
 
void OnDomainModified ()
 
void Check (vtkIdType vertexid, bool checked, vtkIdType inedgeid=-1)
 Called to check/uncheck an item. More...
 
void UpdateCheck (vtkIdType vertexid)
 Determine vertexid's check state using its immediate children. More...
 
void SetSIL (vtkGraph *)
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Protected Attributes

bool BlockUpdate
 
vtkSMProxyProxy
 
vtkSMStringVectorPropertyProperty
 
vtkGraph * SIL
 
vtkCommand * PropertyObserver
 
vtkCommand * DomainObserver
 

Detailed Description

is a helper for to work with SILs.

vtkSMSILModel makes it easier to make checks/unchecks for the SIL while respecting the links/dependencies defined by the SIL.

There are two ways of initializing the model:

Events:
  • vtkCommand::UpdateDataEvent – fired when the check state of any element changes. calldata = vertexid for the element whose check state changed.

Definition at line 47 of file vtkSMSILModel.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 of file vtkSMSILModel.h.

Member Enumeration Documentation

◆ CheckState

Enumerator
UNCHECKED 
PARTIAL 
CHECKED 

Definition at line 54 of file vtkSMSILModel.h.

Constructor & Destructor Documentation

◆ vtkSMSILModel()

vtkSMSILModel::vtkSMSILModel ( )
protected

◆ ~vtkSMSILModel()

virtual vtkSMSILModel::~vtkSMSILModel ( )
protectedvirtual

Member Function Documentation

◆ New()

static vtkSMSILModel* vtkSMSILModel::New ( )
static

◆ GetClassName()

virtual const char* vtkSMSILModel::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMObject.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ Initialize() [1/2]

void vtkSMSILModel::Initialize ( vtkGraph *  sil)

Initialize the model using a SIL.

There are two ways of initializing the model:

  • One way is to initialize it with a SIL (using Initialize(vtkGraph*). Then the model can be used as a simple API to check/uncheck elements.
  • Second way is to initialize with a proxy and property (using Initialize(vtkSMProxy, vtkSMProperty*). In that case, the SIL is obtained from the property's vtkSMSILDomain. Also as the user changes the check states, the property is updated/pushed.

◆ GetSIL()

virtual vtkGraph* vtkSMSILModel::GetSIL ( )
virtual

Initialize the model using a SIL.

There are two ways of initializing the model:

  • One way is to initialize it with a SIL (using Initialize(vtkGraph*). Then the model can be used as a simple API to check/uncheck elements.
  • Second way is to initialize with a proxy and property (using Initialize(vtkSMProxy, vtkSMProperty*). In that case, the SIL is obtained from the property's vtkSMSILDomain. Also as the user changes the check states, the property is updated/pushed.

◆ Initialize() [2/2]

void vtkSMSILModel::Initialize ( vtkSMProxy ,
vtkSMStringVectorProperty  
)

Initialize the model using a proxy and its property.

If a property is set, then the model keeps the property updated when the check states are changed or when the property changes, the model's internal check states are updated. If the property has a SILDomain, then the model attaches itself to the domain so that whenever the domains is updated (i.e. a new SIL is obtained from the server) the model updates the sil as well.

There are two ways of initializing the model:

  • One way is to initialize it with a SIL (using Initialize(vtkGraph*). Then the model can be used as a simple API to check/uncheck elements.
  • Second way is to initialize with a proxy and property (using Initialize(vtkSMProxy, vtkSMProperty*). In that case, the SIL is obtained from the property's vtkSMSILDomain. Also as the user changes the check states, the property is updated/pushed.

◆ GetProxy()

virtual vtkSMProxy* vtkSMSILModel::GetProxy ( )
virtual

Initialize the model using a proxy and its property.

If a property is set, then the model keeps the property updated when the check states are changed or when the property changes, the model's internal check states are updated. If the property has a SILDomain, then the model attaches itself to the domain so that whenever the domains is updated (i.e. a new SIL is obtained from the server) the model updates the sil as well.

There are two ways of initializing the model:

  • One way is to initialize it with a SIL (using Initialize(vtkGraph*). Then the model can be used as a simple API to check/uncheck elements.
  • Second way is to initialize with a proxy and property (using Initialize(vtkSMProxy, vtkSMProperty*). In that case, the SIL is obtained from the property's vtkSMSILDomain. Also as the user changes the check states, the property is updated/pushed.

◆ GetProperty()

virtual vtkSMStringVectorProperty* vtkSMSILModel::GetProperty ( )
virtual

Initialize the model using a proxy and its property.

If a property is set, then the model keeps the property updated when the check states are changed or when the property changes, the model's internal check states are updated. If the property has a SILDomain, then the model attaches itself to the domain so that whenever the domains is updated (i.e. a new SIL is obtained from the server) the model updates the sil as well.

There are two ways of initializing the model:

  • One way is to initialize it with a SIL (using Initialize(vtkGraph*). Then the model can be used as a simple API to check/uncheck elements.
  • Second way is to initialize with a proxy and property (using Initialize(vtkSMProxy, vtkSMProperty*). In that case, the SIL is obtained from the property's vtkSMSILDomain. Also as the user changes the check states, the property is updated/pushed.

◆ GetNumberOfChildren()

int vtkSMSILModel::GetNumberOfChildren ( vtkIdType  vertexid)

Returns the number of children for the given vertex.

A node is a child node if it has no out-going edges or all out-going edges have "CrossEdges" set to 1. If vertex id is invalid, returns -1.

◆ GetChildVertex()

vtkIdType vtkSMSILModel::GetChildVertex ( vtkIdType  parentid,
int  child_index 
)

Returns the vertex id for the n-th child where n=child_index.

Returns 0 if request is invalid.

◆ GetParentVertex()

vtkIdType vtkSMSILModel::GetParentVertex ( vtkIdType  parent)

Returns the parent vertex i.e.

the vertex at the end of an in-edge which is not a cross-edge. It's an error to call this method for the root vertex id i.e. 0.

◆ GetName()

const char* vtkSMSILModel::GetName ( vtkIdType  vertex)

Get the name for the vertex.

◆ GetCheckStatus()

int vtkSMSILModel::GetCheckStatus ( vtkIdType  vertex)

Get the check state for a vertex.

◆ SetCheckState() [1/2]

bool vtkSMSILModel::SetCheckState ( vtkIdType  vertex,
int  status 
)

Set the check state for a vertex.

Returns true if the status was changed, false if unaffected.

◆ SetCheckState() [2/2]

bool vtkSMSILModel::SetCheckState ( const char *  name,
int  status 
)
inline

Set the check state for a vertex.

Returns true if the status was changed, false if unaffected.

Definition at line 134 of file vtkSMSILModel.h.

◆ CheckAll()

void vtkSMSILModel::CheckAll ( )

Convenience methods to check/uncheck all items.

◆ UncheckAll()

void vtkSMSILModel::UncheckAll ( )

Convenience methods to check/uncheck all items.

◆ UpdatePropertyValue()

void vtkSMSILModel::UpdatePropertyValue ( vtkSMStringVectorProperty )

Updates the property using the check states maintained by the model.

◆ UpdateStateFromProperty()

void vtkSMSILModel::UpdateStateFromProperty ( vtkSMStringVectorProperty )

Updates the check states maintained internally by the model using the status from the property.

◆ FindVertex()

vtkIdType vtkSMSILModel::FindVertex ( const char *  name)

Locate a vertex with the given name.

Returns -1 if the vertex is not found.

◆ GetLeaves()

void vtkSMSILModel::GetLeaves ( std::set< vtkIdType > &  leaves,
vtkIdType  root,
bool  traverse_cross_edges 
)

◆ UpdateProperty()

void vtkSMSILModel::UpdateProperty ( )
protected

◆ OnPropertyModified()

void vtkSMSILModel::OnPropertyModified ( )
protected

◆ OnDomainModified()

void vtkSMSILModel::OnDomainModified ( )
protected

◆ Check()

void vtkSMSILModel::Check ( vtkIdType  vertexid,
bool  checked,
vtkIdType  inedgeid = -1 
)
protected

Called to check/uncheck an item.

◆ UpdateCheck()

void vtkSMSILModel::UpdateCheck ( vtkIdType  vertexid)
protected

Determine vertexid's check state using its immediate children.

If the check-state for the vertex has changed, then it propagates the call to the parent node.

◆ SetSIL()

void vtkSMSILModel::SetSIL ( vtkGraph *  )
protected

Member Data Documentation

◆ BlockUpdate

bool vtkSMSILModel::BlockUpdate
protected

Definition at line 188 of file vtkSMSILModel.h.

◆ Proxy

vtkSMProxy* vtkSMSILModel::Proxy
protected

Definition at line 192 of file vtkSMSILModel.h.

◆ Property

vtkSMStringVectorProperty* vtkSMSILModel::Property
protected

Definition at line 193 of file vtkSMSILModel.h.

◆ SIL

vtkGraph* vtkSMSILModel::SIL
protected

Definition at line 194 of file vtkSMSILModel.h.

◆ PropertyObserver

vtkCommand* vtkSMSILModel::PropertyObserver
protected

Definition at line 195 of file vtkSMSILModel.h.

◆ DomainObserver

vtkCommand* vtkSMSILModel::DomainObserver
protected

Definition at line 196 of file vtkSMSILModel.h.


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