vtkRulerSourceRepresentation is a representation to show a ruler. More...

#include <vtkRulerSourceRepresentation.h>

Inheritance diagram for vtkRulerSourceRepresentation:

Collaboration diagram for vtkRulerSourceRepresentation:

[legend]

Public Types
typedef vtkPVDataRepresentation	Superclass

Public Types inherited from vtkPVDataRepresentation
enum	{ SkippedUpdateDataEvent = vtkCommand::UserEvent + 91, UpdateTimeChangedEvent }

typedef vtkDataRepresentation	Superclass

Public Types inherited from vtkDataRepresentation
typedef vtkPassInputTypeAlgorithm	Superclass

Public Types inherited from vtkPassInputTypeAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision

enum	DesiredOutputPrecision

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetTextProperty (vtkTextProperty *prop)
	Set the text property for the printed distance. More...

void	SetAxisLineWidth (float width)
	Set the line width for the displayed axis in screen units. More...

void	SetAxisColor (double red, double green, double blue)
	Set the color for the displayed axis. More...

void	SetVisibility (bool) override
	Set the visibility. More...

void	SetLabelFormat (char *labelFormat)
	Specify the format to use for labeling the distance. More...

void	SetNumberOfRulerTicks (int numberOfRulerTicks)
	Specify the number of major ruler ticks. More...

int	ProcessViewRequest (vtkInformationRequestKey request_type, vtkInformation inInfo, vtkInformation *outInfo) override
	vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...


void	SetDistanceRepresentation (vtkDistanceRepresentation2D *)
	Set the text widget. More...

virtual vtkDistanceRepresentation2D *	GetDistanceRepresentation ()
	Set the text widget. More...


void	SetRulerMode (int choice)
	Enable or disable ruler mode. More...

int	GetRulerMode ()
	Enable or disable ruler mode. More...


void	SetRulerDistance (double distance)
	Specify the RulerDistance which indicates the spacing of the major ticks in the unit space obtained after the Scale is applied (see SetScale()). More...

double	GetRulerDistance ()
	Specify the RulerDistance which indicates the spacing of the major ticks in the unit space obtained after the Scale is applied (see SetScale()). More...


void	SetScale (double distance)
	Set scale factor to apply to the ruler graduation scale and the displayed distance. More...

double	GetScale ()
	Set scale factor to apply to the ruler graduation scale and the displayed distance. More...

Public Member Functions inherited from vtkPVDataRepresentation
virtual void	MarkModified ()
	This is one of the most important functions. More...

virtual unsigned int	Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable)
	Initialize the representation with an identifier range so each internal representation can own a unique ID. More...

unsigned int	GetUniqueIdentifier ()
	Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object. More...

virtual bool	GetVisibility ()

virtual vtkDataObject *	GetRenderedDataObject (int vtkNotUsed(port))
	Returns the data object that is rendered from the given input port. More...

double	GetCacheKey () const
	Returns the cache-key the representation is currently using. More...

vtkAlgorithmOutput *	GetInternalOutputPort () override
	Retrieves an output port for the input data object at the specified port and connection index. More...

vtkAlgorithmOutput *	GetInternalOutputPort (int port) override

vtkAlgorithmOutput *	GetInternalOutputPort (int port, int conn) override

vtkView *	GetView () const
	Provides access to the view. More...

vtkMTimeType	GetPipelineDataTime ()
	Returns the timestamp when `RequestData` was executed on the representation. More...

bool	GetNeedsUpdate ()
	Returns true if the representation needs an update. More...

virtual void	SetArrayIdNames (const char vtkNotUsed(pointArray), const char vtkNotUsed(cellArray))
	Specify the array names used for the selection. More...

virtual void	SetUpdateTime (double time)
	Set the update time. More...

virtual double	GetUpdateTime ()
	Set the update time. More...

virtual bool	GetUpdateTimeValid ()
	Get whether the UpdateTime is valid. More...

void	ResetUpdateTime ()
	Get whether the UpdateTime is valid. More...

virtual void	SetForcedCacheKey (double val)
	Generally, caching is within the purview of the vtkPVView (and subclasses). More...

virtual void	SetForceUseCache (bool val)
	Generally, caching is within the purview of the vtkPVView (and subclasses). More...

virtual double	GetForcedCacheKey ()
	Generally, caching is within the purview of the vtkPVView (and subclasses). More...

virtual bool	GetForceUseCache ()
	Generally, caching is within the purview of the vtkPVView (and subclasses). More...

bool	AddToView (vtkView *view) override
	Making these methods public. More...

bool	RemoveFromView (vtkView *view) override
	Making these methods public. More...

virtual void	SetLogName (const std::string &name)
	This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...

const std::string &	GetLogName () const
	This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...

virtual bool	GetHasTemporalPipeline ()
	This flag indicates if the representation is for a temporal pipeline. More...

virtual void	SetHasTemporalPipeline (bool)
	This flag indicates if the representation is for a temporal pipeline. More...

void	SetInputConnection (int port, vtkAlgorithmOutput *input) override
	Overridden to ensure that `MarkModified` is called. More...

void	AddInputConnection (int port, vtkAlgorithmOutput *input) override
	Overridden to ensure that `MarkModified` is called. More...

Public Member Functions inherited from vtkDataRepresentation
vtkDataRepresentation *	NewInstance () const

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 void	SetSelectionType (int)

virtual int	GetSelectionType ()

virtual void	SetSelectionArrayNames (vtkStringArray *names)

virtual vtkStringArray *	GetSelectionArrayNames ()

virtual void	SetSelectionArrayName (const char *name)

virtual const char *	GetSelectionArrayName ()

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 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)

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 int	Update (int port, vtkInformationVector *requests)

virtual int	Update (vtkInformation *requests)

virtual int	UpdateExtent (const int extents[6])

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])

void	SetUpdateExtent (int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

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 (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 int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

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)

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 ()

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

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 (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 int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

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)

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
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

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)

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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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)

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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkRulerSourceRepresentation *	New ()

static int	IsTypeOf (const char *type)

static vtkRulerSourceRepresentation *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkPVDataRepresentation
static int	IsTypeOf (const char *type)

static vtkPVDataRepresentation *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkDataRepresentation
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 vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkRulerSourceRepresentation ()

	~vtkRulerSourceRepresentation () override

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	Overridden to invoke vtkCommand::UpdateDataEvent. More...

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill input port information. More...

bool	AddToView (vtkView *view) override
	Adds the representation to the view. More...

bool	RemoveFromView (vtkView *view) override
	Removes the representation to the view. More...

Protected Member Functions inherited from vtkPVDataRepresentation
	vtkPVDataRepresentation ()

	~vtkPVDataRepresentation () override

vtkExecutive *	CreateDefaultExecutive () override
	Create a default executive. More...

int	RequestUpdateExtent (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector ) override

Protected Member Functions inherited from vtkDataRepresentation
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 void	SetAnnotationLinkInternal (vtkAnnotationLink *link)

Protected Member Functions inherited from vtkPassInputTypeAlgorithm
	vtkPassInputTypeAlgorithm ()

	~vtkPassInputTypeAlgorithm ()

virtual int	RequestUpdateTimeDependentInformation (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

vtkDataObject *	GetInput (int port)

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestInformation (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)

void	ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE

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)

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	SetErrorCode (unsigned long)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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
vtkDistanceRepresentation2D *	DistanceRepresentation

vtkNew< vtkPolyData >	Clone

Protected Attributes inherited from vtkPVDataRepresentation
double	UpdateTime

bool	UpdateTimeValid

unsigned int	UniqueIdentifier

Protected Attributes inherited from vtkDataRepresentation
bool	Selectable

int	SelectionType

vtkStringArray *	SelectionArrayNames

Command *	Observer

vtkAnnotationLink *	AnnotationLinkInternal

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

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
	SINGLE_PRECISION

	DOUBLE_PRECISION

	DEFAULT_PRECISION

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

vtkRulerSourceRepresentation is a representation to show a ruler.

The input is expected to be vtkPolyData with two points.

Definition at line 22 of file vtkRulerSourceRepresentation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPVDataRepresentation vtkRulerSourceRepresentation::Superclass

Definition at line 26 of file vtkRulerSourceRepresentation.h.

Constructor & Destructor Documentation

◆ vtkRulerSourceRepresentation()

vtkRulerSourceRepresentation::vtkRulerSourceRepresentation ( )

protected

◆ ~vtkRulerSourceRepresentation()

vtkRulerSourceRepresentation::~vtkRulerSourceRepresentation ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkRulerSourceRepresentation* vtkRulerSourceRepresentation::New ( )

static

◆ GetClassName()

virtual const char* vtkRulerSourceRepresentation::GetClassName ( )

virtual

Reimplemented from vtkPVDataRepresentation.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkPVDataRepresentation.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkPVDataRepresentation.

◆ SetDistanceRepresentation()

void vtkRulerSourceRepresentation::SetDistanceRepresentation ( vtkDistanceRepresentation2D * )

Set the text widget.

◆ GetDistanceRepresentation()

virtual vtkDistanceRepresentation2D* vtkRulerSourceRepresentation::GetDistanceRepresentation ( )

virtual

Set the text widget.

◆ SetTextProperty()

void vtkRulerSourceRepresentation::SetTextProperty ( vtkTextProperty * prop )

Set the text property for the printed distance.

◆ SetAxisLineWidth()

void vtkRulerSourceRepresentation::SetAxisLineWidth ( float width )

Set the line width for the displayed axis in screen units.

◆ SetAxisColor()

void vtkRulerSourceRepresentation::SetAxisColor	(	double	red,
		double	green,
		double	blue
	)

Set the color for the displayed axis.

◆ SetVisibility()

void vtkRulerSourceRepresentation::SetVisibility ( bool )

overridevirtual

Set the visibility.

Reimplemented from vtkPVDataRepresentation.

◆ SetLabelFormat()

void vtkRulerSourceRepresentation::SetLabelFormat ( char * labelFormat )

Specify the format to use for labeling the distance.

Note that an empty string results in no label, or a format string without a "%" character will not print the distance value.

◆ SetRulerMode()

void vtkRulerSourceRepresentation::SetRulerMode ( int choice )

Enable or disable ruler mode.

When enabled, the ticks on the distance widget are separated by the amount specified by vtkDistanceRepresentation::RulerDistance. Otherwise, the value vtkDistanceRepresentation::NumberOfRulerTicks is used to draw the tick marks.

◆ GetRulerMode()

int vtkRulerSourceRepresentation::GetRulerMode ( )

Enable or disable ruler mode.

When enabled, the ticks on the distance widget are separated by the amount specified by vtkDistanceRepresentation::RulerDistance. Otherwise, the value vtkDistanceRepresentation::NumberOfRulerTicks is used to draw the tick marks.

◆ SetRulerDistance()

void vtkRulerSourceRepresentation::SetRulerDistance ( double distance )

Specify the RulerDistance which indicates the spacing of the major ticks in the unit space obtained after the Scale is applied (see SetScale()).

This ivar only has effect when the RulerMode is on.

◆ GetRulerDistance()

double vtkRulerSourceRepresentation::GetRulerDistance ( )

Specify the RulerDistance which indicates the spacing of the major ticks in the unit space obtained after the Scale is applied (see SetScale()).

This ivar only has effect when the RulerMode is on.

◆ SetScale()

void vtkRulerSourceRepresentation::SetScale ( double distance )

Set scale factor to apply to the ruler graduation scale and the displayed distance.

Used to transform VTK world space units to a desired unit, e.g., inches to centimeters.

◆ GetScale()

double vtkRulerSourceRepresentation::GetScale ( )

Set scale factor to apply to the ruler graduation scale and the displayed distance.

Used to transform VTK world space units to a desired unit, e.g., inches to centimeters.

◆ SetNumberOfRulerTicks()

void vtkRulerSourceRepresentation::SetNumberOfRulerTicks ( int numberOfRulerTicks )

Specify the number of major ruler ticks.

Note: the number of ticks is the number between the two handle endpoints. This ivar only has effect when the RulerMode is off.

◆ ProcessViewRequest()

int vtkRulerSourceRepresentation::ProcessViewRequest	(	vtkInformationRequestKey *	request_type,
		vtkInformation *	inInfo,
		vtkInformation *	outInfo
	)

overridevirtual

vtkAlgorithm::ProcessRequest() equivalent for rendering passes.

This is typically called by the vtkView to request meta-data from the representations or ask them to perform certain tasks e.g. PrepareForRendering.

Reimplemented from vtkPVDataRepresentation.

◆ RequestData()

int vtkRulerSourceRepresentation::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overrideprotectedvirtual

Overridden to invoke vtkCommand::UpdateDataEvent.

Reimplemented from vtkPVDataRepresentation.

◆ FillInputPortInformation()

int vtkRulerSourceRepresentation::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotectedvirtual

Fill input port information.

Reimplemented from vtkPassInputTypeAlgorithm.

◆ AddToView()

bool vtkRulerSourceRepresentation::AddToView ( vtkView * view )

overrideprotected

Adds the representation to the view.

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

◆ RemoveFromView()

bool vtkRulerSourceRepresentation::RemoveFromView ( vtkView * view )

overrideprotected

Removes the representation to the view.

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

Member Data Documentation

◆ DistanceRepresentation

vtkDistanceRepresentation2D* vtkRulerSourceRepresentation::DistanceRepresentation

protected

Definition at line 137 of file vtkRulerSourceRepresentation.h.

◆ Clone

vtkNew<vtkPolyData> vtkRulerSourceRepresentation::Clone

protected

Definition at line 138 of file vtkRulerSourceRepresentation.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkRulerSourceRepresentation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkRulerSourceRepresentation()

◆ ~vtkRulerSourceRepresentation()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetDistanceRepresentation()

◆ GetDistanceRepresentation()

◆ SetTextProperty()

◆ SetAxisLineWidth()

◆ SetAxisColor()

◆ SetVisibility()

◆ SetLabelFormat()

◆ SetRulerMode()

◆ GetRulerMode()

◆ SetRulerDistance()

◆ GetRulerDistance()

◆ SetScale()

◆ GetScale()

◆ SetNumberOfRulerTicks()

◆ ProcessViewRequest()

◆ RequestData()

◆ FillInputPortInformation()

◆ AddToView()

◆ RemoveFromView()

Member Data Documentation

◆ DistanceRepresentation

◆ Clone