vtkAssemblyPath Class Reference

a list of nodes that form an assembly path More...

#include <vtkAssemblyPath.h>

Inheritance diagram for vtkAssemblyPath:

Collaboration diagram for vtkAssemblyPath:

Public Types
typedef vtkCollection	Superclass
Public Types inherited from vtkCollection
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkAssemblyPath *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
void	AddNode (vtkProp *p, vtkMatrix4x4 *m)
	Convenience method adds a prop and matrix together, creating an assembly node transparently. More...
vtkAssemblyNode *	GetNextNode ()
	Get the next assembly node in the list. More...
vtkAssemblyNode *	GetFirstNode ()
	Get the first assembly node in the list. More...
vtkAssemblyNode *	GetLastNode ()
	Get the last assembly node in the list. More...
void	DeleteLastNode ()
	Delete the last assembly node in the list. More...
void	ShallowCopy (vtkAssemblyPath *path)
	Perform a shallow copy (reference counted) on the incoming path. More...
virtual vtkMTimeType	GetMTime ()
	Override the standard GetMTime() to check for the modified times of the nodes in this path. More...
vtkAssemblyNode *	GetNextNode (vtkCollectionSimpleIterator &cookie)
	Reentrant safe way to get an object in a collection. More...
Public Member Functions inherited from vtkCollection
vtkCollection *	NewInstance () const
void	AddItem (vtkObject *)
	Add an object to the list. More...
void	InsertItem (int i, vtkObject *)
	Insert item into the list after the i'th item. More...
void	ReplaceItem (int i, vtkObject *)
	Replace the i'th item in the collection with a. More...
void	RemoveItem (int i)
	Remove the i'th item in the list. More...
void	RemoveItem (vtkObject *)
	Remove an object from the list. More...
void	RemoveAllItems ()
	Remove all objects from the list. More...
int	IsItemPresent (vtkObject *a)
	Search for an object and return location in list. More...
int	GetNumberOfItems ()
	Return the number of objects in the list. More...
void	InitTraversal ()
	Initialize the traversal of the collection. More...
void	InitTraversal (vtkCollectionSimpleIterator &cookie)
	A reentrant safe way to iterate through a collection. More...
vtkObject *	GetNextItemAsObject ()
	Get the next item in the collection. More...
vtkObject *	GetItemAsObject (int i)
	Get the i'th item in the collection. More...
vtkObject *	GetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
	A reentrant safe way to get the next object as a collection. More...
VTK_NEWINSTANCE vtkCollectionIterator *	NewIterator ()
	Get an iterator to traverse the objects in this collection. More...
void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...
void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on. More...
virtual void	DebugOff ()
	Turn debugging output off. More...
bool	GetDebug ()
	Get the value of the debug flag. More...
void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...
virtual void	Modified ()
	Update the modification time for this object. More...
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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
int	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...
virtual void	Delete ()
	Delete a VTK object. More...
virtual void	FastDelete ()
	Delete a reference to this object. More...
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream. More...
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
void	PrintRevisions (ostream &)
	Legacy. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkAssemblyPath *	SafeDownCast (vtkObjectBase *o)
static vtkAssemblyPath *	New ()
	Instantiate empty path with identify matrix. More...
Static Public Member Functions inherited from vtkCollection
static int	IsTypeOf (const char *type)
static vtkCollection *	SafeDownCast (vtkObjectBase *o)
static vtkCollection *	New ()
	Construct with empty list. More...
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAssemblyPath ()
	~vtkAssemblyPath ()
void	AddNode (vtkAssemblyNode *n)
Protected Member Functions inherited from vtkCollection
	vtkCollection ()
	~vtkCollection () override
virtual void	RemoveElement (vtkCollectionElement *element, vtkCollectionElement *previous)
virtual void	DeleteElement (vtkCollectionElement *)
void	ReportReferences (vtkGarbageCollector *collector) override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTransform *	Transform
vtkProp *	TransformedProp
Protected Attributes inherited from vtkCollection
int	NumberOfItems
vtkCollectionElement *	Top
vtkCollectionElement *	Bottom
vtkCollectionElement *	Current
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

a list of nodes that form an assembly path

vtkAssemblyPath represents an ordered list of assembly nodes that represent a fully evaluated assembly path. This class is used primarily for picking. Note that the use of this class is to add one or more assembly nodes to form the path. (An assembly node consists of an instance of vtkProp and vtkMatrix4x4, the matrix may be NULL.) As each node is added, the matrices are concatenated to create a final, evaluated matrix.

See also

vtkAssemblyNode vtkAssembly vtkActor vtkMatrix4x4 vtkProp vtkAbstractPicker

Definition at line 41 of file vtkAssemblyPath.h.

Member Typedef Documentation

typedef vtkCollection vtkAssemblyPath::Superclass

Definition at line 44 of file vtkAssemblyPath.h.

Constructor & Destructor Documentation

vtkAssemblyPath::vtkAssemblyPath ( )

protected

vtkAssemblyPath::~vtkAssemblyPath ( )

protected

Member Function Documentation

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

static

virtual int vtkAssemblyPath::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCollection.

static vtkAssemblyPath* vtkAssemblyPath::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkAssemblyPath::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCollection.

vtkAssemblyPath* vtkAssemblyPath::NewInstance

(

)

const

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

virtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkCollection.

static vtkAssemblyPath* vtkAssemblyPath::New ( )

static

Instantiate empty path with identify matrix.

void vtkAssemblyPath::AddNode	(	vtkProp *	p,
		vtkMatrix4x4 *	m
	)

Convenience method adds a prop and matrix together, creating an assembly node transparently.

The matrix pointer m may be NULL. Note: that matrix is the one, if any, associated with the prop.

vtkAssemblyNode* vtkAssemblyPath::GetNextNode

(

)

Get the next assembly node in the list.

The node returned contains a pointer to a prop and a 4x4 matrix. The matrix is evaluated based on the preceding assembly hierarchy (i.e., the matrix is not necessarily as the same as the one that was added with AddNode() because of the concatenation of matrices in the assembly hierarchy).

vtkAssemblyNode* vtkAssemblyPath::GetFirstNode

(

)

Get the first assembly node in the list.

See the comments for GetNextNode() regarding the contents of the returned node. (Note: This node corresponds to the vtkProp associated with the vtkRenderer.

vtkAssemblyNode* vtkAssemblyPath::GetLastNode

(

)

Get the last assembly node in the list.

See the comments for GetNextNode() regarding the contents of the returned node.

void vtkAssemblyPath::DeleteLastNode

(

)

Delete the last assembly node in the list.

This is like a stack pop.

void vtkAssemblyPath::ShallowCopy

(

vtkAssemblyPath *

path

)

Perform a shallow copy (reference counted) on the incoming path.

virtual vtkMTimeType vtkAssemblyPath::GetMTime ( )

virtual

Override the standard GetMTime() to check for the modified times of the nodes in this path.

Reimplemented from vtkObject.

vtkAssemblyNode* vtkAssemblyPath::GetNextNode ( vtkCollectionSimpleIterator &  cookie )

inline

Reentrant safe way to get an object in a collection.

Just pass the same cookie back and forth.

Definition at line 105 of file vtkAssemblyPath.h.

void vtkAssemblyPath::AddNode ( vtkAssemblyNode *  n )

protected

Member Data Documentation

vtkTransform* vtkAssemblyPath::Transform

protected

Definition at line 113 of file vtkAssemblyPath.h.

vtkProp* vtkAssemblyPath::TransformedProp

protected

Definition at line 114 of file vtkAssemblyPath.h.

---

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

• /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/Core/vtkAssemblyPath.h