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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkAssemblyPath *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	AddNode (vtkProp *p, vtkMatrix4x4 *m)
vtkAssemblyNode *	GetNextNode ()
vtkAssemblyNode *	GetFirstNode ()
vtkAssemblyNode *	GetLastNode ()
void	DeleteLastNode ()
void	ShallowCopy (vtkAssemblyPath *path)
virtual unsigned long	GetMTime ()
vtkAssemblyNode *	GetNextNode (vtkCollectionSimpleIterator &cookie)
Public Member Functions inherited from vtkCollection
vtkCollection *	NewInstance () const
void	AddItem (vtkObject *)
void	InsertItem (int i, vtkObject *)
void	ReplaceItem (int i, vtkObject *)
void	RemoveItem (int i)
void	RemoveItem (vtkObject *)
void	RemoveAllItems ()
int	IsItemPresent (vtkObject *a)
int	GetNumberOfItems ()
void	InitTraversal ()
vtkObject *	GetNextItemAsObject ()
vtkObject *	GetItemAsObject (int i)
vtkCollectionIterator *	NewIterator ()
void	InitTraversal (vtkCollectionSimpleIterator &cookie)
vtkObject *	GetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
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 *)
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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkAssemblyPath *	SafeDownCast (vtkObjectBase *o)
static vtkAssemblyPath *	New ()
Static Public Member Functions inherited from vtkCollection
static int	IsTypeOf (const char *type)
static vtkCollection *	SafeDownCast (vtkObjectBase *o)
static vtkCollection *	New ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAssemblyPath ()
	~vtkAssemblyPath ()
void	AddNode (vtkAssemblyNode *n)
Protected Member Functions inherited from vtkCollection
virtual void	RemoveElement (vtkCollectionElement *element, vtkCollectionElement *previous)
virtual void	DeleteElement (vtkCollectionElement *)
virtual void	ReportReferences (vtkGarbageCollector *collector)
	vtkCollection ()
	~vtkCollection ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
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 40 of file vtkAssemblyPath.h.

Member Typedef Documentation

typedef vtkCollection vtkAssemblyPath::Superclass

Definition at line 43 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 unsigned long 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 84 of file vtkAssemblyPath.h.

void vtkAssemblyPath::AddNode ( vtkAssemblyNode *  n )

protected

Member Data Documentation

vtkTransform* vtkAssemblyPath::Transform

protected

Definition at line 94 of file vtkAssemblyPath.h.

vtkProp* vtkAssemblyPath::TransformedProp

protected

Definition at line 95 of file vtkAssemblyPath.h.

---

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

• dox/Rendering/Core/vtkAssemblyPath.h