Base class for ObjectTree nodes. More...

#include <vtkKWEObjectTreeNodeBase.h>

Inheritance diagram for vtkKWEObjectTreeNodeBase:

Collaboration diagram for vtkKWEObjectTreeNodeBase:

Public Types
enum	NodeStates { ACTIVE_STATE, INACTIVE_STATE }
Public Member Functions
	vtkTypeRevisionMacro (vtkKWEObjectTreeNodeBase, vtkKWESerializableObject)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual unsigned int	GetNumberOfChildren ()
virtual int	AddChild (vtkKWEObjectTreeNodeBase *childNode)
virtual int	InsertChild (unsigned int index, vtkKWEObjectTreeNodeBase *childNode)
int	RemoveChild (vtkKWEObjectTreeNodeBase *childNode)
int	RemoveChild (unsigned int index)
vtkKWEObjectTreeNodeBase *	GetChild (unsigned int index)
virtual bool	IsDescendant (vtkKWEObjectTreeNodeBase *testNode)
int	AddProperty (vtkKWEObjectTreePropertyBase *nodeProperty)
void	GetAllProperties (vtkInformation *allProperties)
int	RemoveProperty (vtkInformationObjectBaseKey *propertyKey)
int	RemoveProperty (vtkKWEObjectTreePropertyBase *nodeProperty)
void	RemoveAllProperties ()
int	GetNumberOfProperties ()
virtual void	Modified ()
virtual unsigned long	GetMTime ()
virtual void	Serialize (vtkKWESerializer *)
const char *	GetUUID ()
void	SetUUID (const char *uuid)
int	CreateUUID ()
void	ClearUUID ()
void	SetStateToActive ()
void	SetStateToInactive ()
void	SetState (int nodeState)
int	GetState ()
const char *	GetStateAsString ()


virtual void	SetNodeObject (vtkObject *object)
virtual vtkObject *	GetNodeObject ()


virtual vtkKWEObjectTreeNodeBase *	GetParent ()


vtkKWEObjectTreePropertyBase *	GetProperty (vtkInformationObjectBaseKey *propertyKey, bool &inheritedProperty, bool includeInheritance=false)


virtual unsigned long	GetTreeModifiedTime ()


virtual bool	IsEqualTo (vtkKWEObjectTreeNodeBase *testNode, bool checkDescendants, bool canBeSuperset=false, bool considerInheritedProperties=false)


const char *	GetName ()
void	SetName (const char *name)


void	InheritPropertiesOn ()
void	InheritPropertiesOff ()
bool	CanInheritProperties ()
bool	GetInheritProperties ()
void	SetInheritProperties (bool inheritState)
Static Public Member Functions
static vtkKWEObjectTreeNodeBase *	New ()
static vtkInformationStringKey *	NAME ()
static vtkInformationStringKey *	UUID ()
static vtkInformationIntegerKey *	STATE ()
static vtkInformationIntegerKey *	INHERIT_PROPERTIES ()
Protected Member Functions
	vtkKWEObjectTreeNodeBase ()
virtual	~vtkKWEObjectTreeNodeBase ()
void	SetParent (vtkKWEObjectTreeNodeBase *parent)
void	AddInheritedProperties (vtkInformation *allProperties)
int	GetNumberOfInformationEntries (vtkInformation *infoObject)
virtual void	SerializeObject (vtkKWESerializer *)
Protected Attributes
vtkKWEObjectTreeNodeBaseChildren *	Children
vtkKWEObjectTreeNodeBase *	Parent
vtkInformation *	Properties
vtkInformation *	Attributes
unsigned long	TreeModifiedTime
vtkObject *	NodeObject

class	vtkKWEObjectTreeNodeIterator
void	AddChildren (vtkKWEObjectTreeNodeIterator *iterator)

class	vtkKWEObjectTreePropertyBase
virtual void	UpdateTreeModifiedTime (unsigned long treeTime)

Detailed Description

Base class for ObjectTree nodes.

The base class for ObjectTree nodes, vtkKWEObjectTreeNodeBase provides the ability add and remove children of a node while guaranteeing that a cycle isn't created. Also, to change the characteristics of a "basic" node type, subclasses of vtkKWEObjectTreePropertyBase can be added to a node, though a node can only have one instance of each property type (such as vtkKWEObjectTreeUserProperty). Though not implemented yet, descendants of a node could (or would?) inherit these properties, if they don't have an instance of the propeoerty type themselves. Similar to Properties, but not to be inherited by a descendant are Attributes of a node. These are more basic charateristics of the node, including the "Name" of the node as well as its "State" (if "inactive", the node is "off", and children are not traversed). If requested, a node will also generate a UUID for the purpose of uniquely identifying a node.

As a subclass of vtkKWESerializableObject, this object can easily be serialized via its Serialize method.

See also:: vtkKWEObjectTreeTransformableNode vtkKWEObjectTreePropertyBase

Definition at line 61 of file vtkKWEObjectTreeNodeBase.h.

Member Enumeration Documentation

enum vtkKWEObjectTreeNodeBase::NodeStates

Enumerator:

ACTIVE_STATE
INACTIVE_STATE

Definition at line 202 of file vtkKWEObjectTreeNodeBase.h.

Constructor & Destructor Documentation

vtkKWEObjectTreeNodeBase::vtkKWEObjectTreeNodeBase ( ) [protected]

virtual vtkKWEObjectTreeNodeBase::~vtkKWEObjectTreeNodeBase ( ) [protected, virtual]

Member Function Documentation

static vtkKWEObjectTreeNodeBase* vtkKWEObjectTreeNodeBase::New ( ) [static]

Reimplemented from vtkKWESerializableObject.

Reimplemented in vtkKWEObjectTreeTransformableNode.

vtkKWEObjectTreeNodeBase::vtkTypeRevisionMacro	(	vtkKWEObjectTreeNodeBase	,
		vtkKWESerializableObject
	)

void vtkKWEObjectTreeNodeBase::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Reimplemented from vtkObject.

Reimplemented in vtkKWEObjectTreeTransformableNode.

virtual void vtkKWEObjectTreeNodeBase::SetNodeObject ( vtkObject * object ) [virtual]

Set/Get the vtkObject for this node.

virtual vtkObject* vtkKWEObjectTreeNodeBase::GetNodeObject ( ) [virtual]

Set/Get the vtkObject for this node.

virtual unsigned int vtkKWEObjectTreeNodeBase::GetNumberOfChildren ( ) [virtual]

Returns number of children this node has.

virtual int vtkKWEObjectTreeNodeBase::AddChild ( vtkKWEObjectTreeNodeBase * childNode ) [virtual]

Add the child to this node and set this node as its parent. The node is added only if unique (not already a child), if the node doesn't have a parent (which actually handles its uniqueness as a child), and if a cycle won't be created by adding the child. Returns index of the child (-1 if not added).

virtual int vtkKWEObjectTreeNodeBase::InsertChild	(	unsigned int	index,
		vtkKWEObjectTreeNodeBase *	childNode
	)			`[virtual]`

Inserts this child at the specified index (0 based)in the child "list" and sets this node as its parent. The node is added only if unique (not already a child), if the index is valid (will not insert at index 3 if only 2 children in the list), if the node doesn't have a parent (which actually handles its uniqueness as a child), and if a cycle won't be created by adding the child. Return 1 if the node is added (0 otherwise);

int vtkKWEObjectTreeNodeBase::RemoveChild ( vtkKWEObjectTreeNodeBase * childNode )

Remove indicated child node. Return index of the child that was removed or -1 if it wasn't a child.

int vtkKWEObjectTreeNodeBase::RemoveChild ( unsigned int index )

Remove child at indicated index. Return 1 if successful (0 otherwise).

vtkKWEObjectTreeNodeBase* vtkKWEObjectTreeNodeBase::GetChild ( unsigned int index )

Get child at indicated index.

virtual vtkKWEObjectTreeNodeBase* vtkKWEObjectTreeNodeBase::GetParent ( ) [virtual]

Get the parent of this node (a value of NULL indicates this node is the root of the tree

virtual bool vtkKWEObjectTreeNodeBase::IsDescendant ( vtkKWEObjectTreeNodeBase * testNode ) [virtual]

Tests whether a node exists in the tree (returns true if it does).

int vtkKWEObjectTreeNodeBase::AddProperty ( vtkKWEObjectTreePropertyBase * nodeProperty )

Add the property to the node; returns 0 if the property was already present (does NOT replace the existing property)

void vtkKWEObjectTreeNodeBase::GetAllProperties ( vtkInformation * allProperties )

Fill the passed vtkInformation object with ALL the properties of this node, including those that this node inherits, IF CanInheritProperties()==true

vtkKWEObjectTreePropertyBase* vtkKWEObjectTreeNodeBase::GetProperty	(	vtkInformationObjectBaseKey *	propertyKey,
		bool &	inheritedProperty,
		bool	includeInheritance = `false`
	)

Retrieves the requested property, if it exists (otherwise returns NULL). If includeInheritance == true (and INHERIT_PROPERTIES is ON), will search ancestors for inheritable property of specified type. The inheritedProperty flag it set to true if the property is inherited from an ancestor.

int vtkKWEObjectTreeNodeBase::RemoveProperty ( vtkInformationObjectBaseKey * propertyKey )

Removes the property with the given Key, if it exists. Returns 1 if the property existed and was removed, 0 otherwise.

int vtkKWEObjectTreeNodeBase::RemoveProperty ( vtkKWEObjectTreePropertyBase * nodeProperty )

Removes the property if it exists. Returns 1 if the property existed and was removed, 0 otherwise.

void vtkKWEObjectTreeNodeBase::RemoveAllProperties ( )

Removes all the node's properties.

int vtkKWEObjectTreeNodeBase::GetNumberOfProperties ( )

Return the number of properties set on this node.

virtual void vtkKWEObjectTreeNodeBase::Modified ( ) [virtual]

Update modifed time for this object and also update the TreeModifiedTime (for this object, and pushes up to parent as well)

Reimplemented from vtkObject.

virtual unsigned long vtkKWEObjectTreeNodeBase::GetMTime ( ) [virtual]

Return this object's modified time, considering the properties of this node. This value is not affected by a child changing (but is by adding or removing a child)

Reimplemented from vtkObject.

Reimplemented in vtkKWEObjectTreeTransformableNode.

virtual unsigned long vtkKWEObjectTreeNodeBase::GetTreeModifiedTime ( ) [virtual]

Return the modified time for this (sub)tree.

virtual bool vtkKWEObjectTreeNodeBase::IsEqualTo	(	vtkKWEObjectTreeNodeBase *	testNode,
		bool	checkDescendants,
		bool	canBeSuperset = `false`,
		bool	considerInheritedProperties = `false`
	)			`[virtual]`

Check to see if the specified node is the same (Attributes and Properties) as this node. If checkDescendants == true, then the children (and their children) are compared as well (and must be in the same order). If canBeSuperset == true, then it is considered "equal" if all attrbiutes and Properties that are set in the testNode match in "this" node (this node can be a superset of testNode); the final flag "considerInheritedProperties" will compare an inherited property as if it were a property specifed on the node.

Reimplemented in vtkKWEObjectTreeTransformableNode.

virtual void vtkKWEObjectTreeNodeBase::Serialize ( vtkKWESerializer * ) [virtual]

Reads the state of an instance from an archive OR writes the state of an instance to an archive.

Reimplemented from vtkKWESerializableObject.

Reimplemented in vtkKWEObjectTreeTransformableNode.

const char* vtkKWEObjectTreeNodeBase::GetName ( )

Set/Get the name of this node.

void vtkKWEObjectTreeNodeBase::SetName ( const char * name )

Set/Get the name of this node.

const char* vtkKWEObjectTreeNodeBase::GetUUID ( )

Get the UUID for this node.

void vtkKWEObjectTreeNodeBase::SetUUID ( const char * uuid )

Set the UUID for this node.

int vtkKWEObjectTreeNodeBase::CreateUUID ( )

Creates a UUID for this node (if one doesn't already exist). Return 0 if already exists, 1 if able to "generate" an uuid, and 2 if it was necessary to "construct" (less unique) an uuid.

void vtkKWEObjectTreeNodeBase::ClearUUID ( )

Clear/remove the UUID for this node. Calling CreateUUID after ClearUUID will create a new/different UUID.

void vtkKWEObjectTreeNodeBase::SetStateToActive ( ) [inline]

Definition at line 208 of file vtkKWEObjectTreeNodeBase.h.

void vtkKWEObjectTreeNodeBase::SetStateToInactive ( ) [inline]

Definition at line 210 of file vtkKWEObjectTreeNodeBase.h.

void vtkKWEObjectTreeNodeBase::SetState ( int nodeState )

int vtkKWEObjectTreeNodeBase::GetState ( )

const char* vtkKWEObjectTreeNodeBase::GetStateAsString ( )

void vtkKWEObjectTreeNodeBase::InheritPropertiesOn ( ) [inline]