vtkDataRepresentation Class Reference

The superclass for all representations. More...

#include <vtkDataRepresentation.h>

Inheritance diagram for vtkDataRepresentation:

Collaboration diagram for vtkDataRepresentation:

Public Types
typedef vtkPassInputTypeAlgorithm	Superclass
Public Types inherited from vtkPassInputTypeAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkDataRepresentation *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
virtual vtkSelection *	ConvertSelection (vtkView *view, vtkSelection *selection)
vtkAlgorithmOutput *	GetInputConnection (int port=0, int index=0)
vtkAnnotationLink *	GetAnnotationLink ()
void	SetAnnotationLink (vtkAnnotationLink *link)
void	Select (vtkView *view, vtkSelection *selection)
void	Select (vtkView *view, vtkSelection *selection, bool extend)
void	Annotate (vtkView *view, vtkAnnotationLayers *annotations)
void	Annotate (vtkView *view, vtkAnnotationLayers *annotations, bool extend)
virtual void	SetSelectable (bool)
virtual bool	GetSelectable ()
virtual void	SelectableOn ()
virtual void	SelectableOff ()
void	UpdateSelection (vtkSelection *selection)
void	UpdateSelection (vtkSelection *selection, bool extend)
void	UpdateAnnotations (vtkAnnotationLayers *annotations)
void	UpdateAnnotations (vtkAnnotationLayers *annotations, bool extend)
virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort ()
virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort (int port)
virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort (int port, int conn)
virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort ()
virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort (int port)
virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort (int port, int conn)
virtual vtkAlgorithmOutput *	GetInternalOutputPort ()
virtual vtkAlgorithmOutput *	GetInternalOutputPort (int port)
virtual vtkAlgorithmOutput *	GetInternalOutputPort (int port, int conn)
virtual void	SetSelectionType (int)
virtual int	GetSelectionType ()
virtual void	SetSelectionArrayNames (vtkStringArray *names)
virtual vtkStringArray *	GetSelectionArrayNames ()
virtual void	SetSelectionArrayName (const char *name)
virtual const char *	GetSelectionArrayName ()
Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPassInputTypeAlgorithm *	NewInstance () const
vtkPolyData *	GetPolyDataOutput ()
vtkStructuredPoints *	GetStructuredPointsOutput ()
vtkImageData *	GetImageDataOutput ()
vtkStructuredGrid *	GetStructuredGridOutput ()
vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
vtkRectilinearGrid *	GetRectilinearGridOutput ()
vtkTable *	GetTableOutput ()
vtkGraph *	GetGraphOutput ()
vtkDataObject *	GetInput ()
vtkDataObject *	GetOutput ()
vtkDataObject *	GetOutput (int)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
void	AddInputData (vtkDataObject *)
void	AddInputData (int, vtkDataObject *)
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
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 vtkDataRepresentation *	New ()
static int	IsTypeOf (const char *type)
static vtkDataRepresentation *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPassInputTypeAlgorithm
static vtkPassInputTypeAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkPassInputTypeAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
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
	vtkDataRepresentation ()
	~vtkDataRepresentation ()
virtual void	ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
virtual bool	AddToView (vtkView *vtkNotUsed(view))
virtual bool	RemoveFromView (vtkView *vtkNotUsed(view))
virtual vtkAnnotationLayers *	ConvertAnnotations (vtkView *view, vtkAnnotationLayers *annotations)
vtkTrivialProducer *	GetInternalInput (int port, int conn)
void	SetInternalInput (int port, int conn, vtkTrivialProducer *producer)
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Member Functions inherited from vtkPassInputTypeAlgorithm
	vtkPassInputTypeAlgorithm ()
	~vtkPassInputTypeAlgorithm ()
virtual int	RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestUpdateTimeDependentInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
vtkDataObject *	GetInput (int port)
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
virtual void	SetErrorCode (unsigned long)
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
bool	Selectable
int	SelectionType
vtkStringArray *	SelectionArrayNames
Command *	Observer
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Friends
class	vtkView
class	vtkRenderView
class	Command
vtkAnnotationLink *	AnnotationLinkInternal
virtual void	SetAnnotationLinkInternal (vtkAnnotationLink *link)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

The superclass for all representations.

vtkDataRepresentation the superclass for representations of data objects. This class itself may be instantiated and used as a representation that simply holds a connection to a pipeline.

If there are multiple representations present in a view, you should use a subclass of vtkDataRepresentation. The representation is responsible for taking the input pipeline connection and converting it to an object usable by a view. In the most common case, the representation will contain the pipeline necessary to convert a data object into an actor or set of actors.

The representation has a concept of a selection. If the user performs a selection operation on the view, the view forwards this on to its representations. The representation is responsible for displaying that selection in an appropriate way.

Representation selections may also be linked. The representation shares the selection by converting it into a view-independent format, then setting the selection on its vtkAnnotationLink. Other representations sharing the same selection link instance will get the same selection from the selection link when the view is updated. The application is responsible for linking representations as appropriate by setting the same vtkAnnotationLink on each linked representation.

Events:

vtkCommand::AnnotationChangedEvent vtkCommand::SelectionChangedEvent

Examples:

vtkDataRepresentation (Examples)

Definition at line 71 of file vtkDataRepresentation.h.

Member Typedef Documentation

typedef vtkPassInputTypeAlgorithm vtkDataRepresentation::Superclass

Definition at line 75 of file vtkDataRepresentation.h.

Constructor & Destructor Documentation

vtkDataRepresentation::vtkDataRepresentation ( )

protected

vtkDataRepresentation::~vtkDataRepresentation ( )

protected

Member Function Documentation

static vtkDataRepresentation* vtkDataRepresentation::New ( )

static

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

static

virtual int vtkDataRepresentation::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 vtkPassInputTypeAlgorithm.

Reimplemented in vtkParallelCoordinatesRepresentation, vtkRenderedGraphRepresentation, vtkParallelCoordinatesHistogramRepresentation, vtkQtTableRepresentation, vtkRenderedTreeAreaRepresentation, vtkRenderedSurfaceRepresentation, vtkGeoAlignedImageRepresentation, vtkRenderedRepresentation, vtkEmptyRepresentation, and vtkRenderedHierarchyRepresentation.

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

static

virtual vtkObjectBase* vtkDataRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPassInputTypeAlgorithm.

Reimplemented in vtkParallelCoordinatesRepresentation, vtkRenderedGraphRepresentation, vtkParallelCoordinatesHistogramRepresentation, vtkQtTableRepresentation, vtkRenderedTreeAreaRepresentation, vtkRenderedSurfaceRepresentation, vtkGeoAlignedImageRepresentation, vtkRenderedRepresentation, vtkEmptyRepresentation, and vtkRenderedHierarchyRepresentation.

vtkDataRepresentation* vtkDataRepresentation::NewInstance

(

)

const

void vtkDataRepresentation::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 vtkPassInputTypeAlgorithm.

Reimplemented in vtkParallelCoordinatesRepresentation, vtkRenderedGraphRepresentation, vtkParallelCoordinatesHistogramRepresentation, vtkQtTableRepresentation, vtkRenderedTreeAreaRepresentation, vtkRenderedSurfaceRepresentation, vtkRenderedRepresentation, vtkEmptyRepresentation, and vtkRenderedHierarchyRepresentation.

vtkAlgorithmOutput* vtkDataRepresentation::GetInputConnection ( int  port = 0, int  index = 0  )

inline

Convenience override method for obtaining the input connection without specifying the port or index.

Definition at line 81 of file vtkDataRepresentation.h.

vtkAnnotationLink* vtkDataRepresentation::GetAnnotationLink ( )

inline

The annotation link for this representation. To link annotations, set the same vtkAnnotationLink object in multiple representations.

Definition at line 88 of file vtkDataRepresentation.h.

void vtkDataRepresentation::SetAnnotationLink

(

vtkAnnotationLink *

link

)

The annotation link for this representation. To link annotations, set the same vtkAnnotationLink object in multiple representations.

virtual void vtkDataRepresentation::ApplyViewTheme ( vtkViewTheme *  vtkNotUsedtheme )

inlinevirtual

Apply a theme to this representation. Subclasses should override this method.

Definition at line 95 of file vtkDataRepresentation.h.

void vtkDataRepresentation::Select ( vtkView *  view, vtkSelection *  selection  )

inline

The view calls this method when a selection occurs. The representation takes this selection and converts it into a selection on its data by calling ConvertSelection, then calls UpdateSelection with the converted selection. Subclasses should not overrride this method, but should instead override ConvertSelection. The optional third argument specifies whether the selection should be added to the previous selection on this representation.

Definition at line 105 of file vtkDataRepresentation.h.

void vtkDataRepresentation::Select	(	vtkView *	view,
		vtkSelection *	selection,
		bool	extend
	)

The view calls this method when a selection occurs. The representation takes this selection and converts it into a selection on its data by calling ConvertSelection, then calls UpdateSelection with the converted selection. Subclasses should not overrride this method, but should instead override ConvertSelection. The optional third argument specifies whether the selection should be added to the previous selection on this representation.

void vtkDataRepresentation::Annotate ( vtkView *  view, vtkAnnotationLayers *  annotations  )

inline

Analogous to Select(). The view calls this method when it needs to change the underlying annotations (some views might perform the creation of annotations). The representation takes the annotations and converts them into a selection on its data by calling ConvertAnnotations, then calls UpdateAnnotations with the converted selection. Subclasses should not overrride this method, but should instead override ConvertSelection. The optional third argument specifies whether the selection should be added to the previous selection on this representation.

Definition at line 120 of file vtkDataRepresentation.h.

void vtkDataRepresentation::Annotate	(	vtkView *	view,
		vtkAnnotationLayers *	annotations,
		bool	extend
	)

Analogous to Select(). The view calls this method when it needs to change the underlying annotations (some views might perform the creation of annotations). The representation takes the annotations and converts them into a selection on its data by calling ConvertAnnotations, then calls UpdateAnnotations with the converted selection. Subclasses should not overrride this method, but should instead override ConvertSelection. The optional third argument specifies whether the selection should be added to the previous selection on this representation.

virtual void vtkDataRepresentation::SetSelectable ( bool  )

virtual

Whether this representation is able to handle a selection. Default is true.

virtual bool vtkDataRepresentation::GetSelectable ( )

virtual

Whether this representation is able to handle a selection. Default is true.

virtual void vtkDataRepresentation::SelectableOn ( )

virtual

Whether this representation is able to handle a selection. Default is true.

virtual void vtkDataRepresentation::SelectableOff ( )

virtual

Whether this representation is able to handle a selection. Default is true.

void vtkDataRepresentation::UpdateSelection ( vtkSelection *  selection )

inline

Updates the selection in the selection link and fires a selection change event. Subclasses should not overrride this method, but should instead override ConvertSelection. The optional second argument specifies whether the selection should be added to the previous selection on this representation.

Definition at line 139 of file vtkDataRepresentation.h.

void vtkDataRepresentation::UpdateSelection	(	vtkSelection *	selection,
		bool	extend
	)

Updates the selection in the selection link and fires a selection change event. Subclasses should not overrride this method, but should instead override ConvertSelection. The optional second argument specifies whether the selection should be added to the previous selection on this representation.

void vtkDataRepresentation::UpdateAnnotations ( vtkAnnotationLayers *  annotations )

inline

Updates the selection in the selection link and fires a selection change event. Subclasses should not overrride this method, but should instead override ConvertSelection. The optional second argument specifies whether the selection should be added to the previous selection on this representation.

Definition at line 150 of file vtkDataRepresentation.h.

void vtkDataRepresentation::UpdateAnnotations	(	vtkAnnotationLayers *	annotations,
		bool	extend
	)

Updates the selection in the selection link and fires a selection change event. Subclasses should not overrride this method, but should instead override ConvertSelection. The optional second argument specifies whether the selection should be added to the previous selection on this representation.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalAnnotationOutputPort ( )

inlinevirtual

The output port that contains the annotations whose selections are localized for a particular input data object. This should be used when connecting the internal pipelines.

Reimplemented in vtkEmptyRepresentation.

Definition at line 159 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalAnnotationOutputPort ( int  port )

inlinevirtual

The output port that contains the annotations whose selections are localized for a particular input data object. This should be used when connecting the internal pipelines.

Reimplemented in vtkEmptyRepresentation.

Definition at line 161 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalAnnotationOutputPort ( int  port, int  conn  )

virtual

The output port that contains the annotations whose selections are localized for a particular input data object. This should be used when connecting the internal pipelines.

Reimplemented in vtkEmptyRepresentation.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalSelectionOutputPort ( )

inlinevirtual

The output port that contains the selection associated with the current annotation (normally the interactive selection). This should be used when connecting the internal pipelines.

Definition at line 170 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalSelectionOutputPort ( int  port )

inlinevirtual

The output port that contains the selection associated with the current annotation (normally the interactive selection). This should be used when connecting the internal pipelines.

Definition at line 172 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalSelectionOutputPort ( int  port, int  conn  )

virtual

The output port that contains the selection associated with the current annotation (normally the interactive selection). This should be used when connecting the internal pipelines.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalOutputPort ( )

inlinevirtual

Retrieves an output port for the input data object at the specified port and connection index. This may be connected to the representation's internal pipeline.

Definition at line 181 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalOutputPort ( int  port )

inlinevirtual

Retrieves an output port for the input data object at the specified port and connection index. This may be connected to the representation's internal pipeline.

Definition at line 183 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalOutputPort ( int  port, int  conn  )

virtual

Retrieves an output port for the input data object at the specified port and connection index. This may be connected to the representation's internal pipeline.

virtual void vtkDataRepresentation::SetSelectionType ( int  )

virtual

Set the selection type produced by this view. This should be one of the content type constants defined in vtkSelectionNode.h. Common values are vtkSelectionNode::INDICES vtkSelectionNode::PEDIGREEIDS vtkSelectionNode::VALUES

virtual int vtkDataRepresentation::GetSelectionType ( )

virtual

Set the selection type produced by this view. This should be one of the content type constants defined in vtkSelectionNode.h. Common values are vtkSelectionNode::INDICES vtkSelectionNode::PEDIGREEIDS vtkSelectionNode::VALUES

virtual void vtkDataRepresentation::SetSelectionArrayNames ( vtkStringArray *  names )

virtual

If a VALUES selection, the arrays used to produce a selection.

virtual vtkStringArray* vtkDataRepresentation::GetSelectionArrayNames ( )

virtual

If a VALUES selection, the arrays used to produce a selection.

virtual void vtkDataRepresentation::SetSelectionArrayName ( const char *  name )

virtual

If a VALUES selection, the array used to produce a selection.

virtual const char* vtkDataRepresentation::GetSelectionArrayName ( )

virtual

If a VALUES selection, the array used to produce a selection.

virtual vtkSelection* vtkDataRepresentation::ConvertSelection ( vtkView *  view, vtkSelection *  selection  )

virtual

Convert the selection to a type appropriate for sharing with other representations through vtkAnnotationLink, possibly using the view. For the superclass, we just return the same selection. Subclasses may do something more fancy, like convert the selection from a frustrum to a list of pedigree ids. If the selection cannot be applied to this representation, return NULL.

Reimplemented in vtkRenderedGraphRepresentation, vtkParallelCoordinatesRepresentation, vtkRenderedTreeAreaRepresentation, vtkRenderedHierarchyRepresentation, and vtkRenderedSurfaceRepresentation.

virtual int vtkDataRepresentation::RequestData ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

inlineprotectedvirtual

Subclasses should override this to connect inputs to the internal pipeline as necessary. Since most representations are "meta-filters" (i.e. filters containing other filters), you should create shallow copies of your input before connecting to the internal pipeline. The convenience method GetInternalOutputPort will create a cached shallow copy of a specified input for you. The related helper functions GetInternalAnnotationOutputPort, GetInternalSelectionOutputPort should be used to obtain a selection or annotation port whose selections are localized for a particular input data object.

Reimplemented from vtkPassInputTypeAlgorithm.

Reimplemented in vtkRenderedGraphRepresentation, vtkRenderedTreeAreaRepresentation, vtkParallelCoordinatesRepresentation, vtkRenderedHierarchyRepresentation, vtkParallelCoordinatesHistogramRepresentation, vtkQtTableRepresentation, and vtkRenderedSurfaceRepresentation.

Definition at line 231 of file vtkDataRepresentation.h.

virtual void vtkDataRepresentation::ProcessEvents ( vtkObject *  caller, unsigned long  eventId, void *  callData  )

protectedvirtual

Clear the input shallow copy caches if the algorithm is in "release data" mode.

virtual void vtkDataRepresentation::SetAnnotationLinkInternal ( vtkAnnotationLink *  link )

protectedvirtual

The annotation link for this representation.

virtual bool vtkDataRepresentation::AddToView ( vtkView *  vtkNotUsedview )

inlineprotectedvirtual

Adds the representation to the view. This is called from vtkView::AddRepresentation(). Subclasses should override this method. Returns true if the addition succeeds.

Definition at line 272 of file vtkDataRepresentation.h.

virtual bool vtkDataRepresentation::RemoveFromView ( vtkView *  vtkNotUsedview )

inlineprotectedvirtual

Removes the representation to the view. This is called from vtkView::RemoveRepresentation(). Subclasses should override this method. Returns true if the removal succeeds.

Definition at line 277 of file vtkDataRepresentation.h.

virtual vtkAnnotationLayers* vtkDataRepresentation::ConvertAnnotations ( vtkView *  view, vtkAnnotationLayers *  annotations  )

protectedvirtual

Analogous to ConvertSelection(), allows subclasses to manipulate annotations before passing them off to vtkAnnotationLink. If the annotations cannot be applied to this representation, return NULL.

vtkTrivialProducer* vtkDataRepresentation::GetInternalInput ( int  port, int  conn  )

protected

void vtkDataRepresentation::SetInternalInput ( int  port, int  conn, vtkTrivialProducer *  producer  )

protected

Friends And Related Function Documentation

friend class vtkView

friend

Definition at line 258 of file vtkDataRepresentation.h.

friend class vtkRenderView

friend

Definition at line 259 of file vtkDataRepresentation.h.

friend class Command

friend

Definition at line 260 of file vtkDataRepresentation.h.

Member Data Documentation

vtkAnnotationLink* vtkDataRepresentation::AnnotationLinkInternal

protected

The annotation link for this representation.

Definition at line 245 of file vtkDataRepresentation.h.

bool vtkDataRepresentation::Selectable

protected

Definition at line 249 of file vtkDataRepresentation.h.

int vtkDataRepresentation::SelectionType

protected

The selection type created by the view.

Definition at line 252 of file vtkDataRepresentation.h.

vtkStringArray* vtkDataRepresentation::SelectionArrayNames

protected

If a VALUES selection, the array names used in the selection.

Definition at line 255 of file vtkDataRepresentation.h.

Command* vtkDataRepresentation::Observer

protected

Definition at line 262 of file vtkDataRepresentation.h.

---

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

• dox/Views/Core/vtkDataRepresentation.h