#include <vtkStandardRenderView.h>

Detailed Description

A render view with convenient defaults for general-purpose rendering.

vtkStandardRenderView extends vtkRenderViewBase with a trackball camera interaction style, sensible default window size, and convenience methods for background colors and starting the event loop.

Users create vtkSurfaceRepresentation or vtkVolumeRepresentation objects, configure them, and add them to this view. Call Start() to enter the interactive event loop.

Example usage:: auto view = vtkNew<vtkStandardRenderView>();

auto rep = vtkNew<vtkSurfaceRepresentation>();

rep->SetInputConnection(source->GetOutputPort());

rep->SetColor(0.8, 0.2, 0.2);

view->AddRepresentation(rep);

view->ResetCamera();

view->Start();

vtkNew
Allocate and hold a VTK object.
Definition vtkNew.h:168

source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition vtkBoostGraphAdapter.h:984

See also: vtkRenderViewBase vtkSurfaceRepresentation vtkVolumeRepresentation

Events:: vtkCommand::SelectionChangedEvent

Examples:: vtkStandardRenderView (Examples)

Tests:: vtkStandardRenderView (Tests)

Definition at line 58 of file vtkStandardRenderView.h.

Inheritance diagram for vtkStandardRenderView:

[legend]

Collaboration diagram for vtkStandardRenderView:

[legend]

Public Types
typedef vtkRenderViewBase	Superclass
Public Types inherited from vtkRenderViewBase
typedef vtkView	Superclass
Public Types inherited from vtkView
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkStandardRenderView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkMTimeType	GetMTime () override
	The view stores its configuration on the renderer, render window, light kit and orientation marker widget rather than in its own ivars, so the modified time reported here is the latest of this object's own and theirs.
vtkOrientationMarkerWidget *	GetOrientationMarkerWidget ()
	Provide access to the orientation marker widget for advanced usage.
vtkLightKit *	GetLightKit ()
	Provide access to the internal light kit for advanced usage.
void	SelectRegion (int x0, int y0, int x1, int y1, bool extend=false)
	Select the screen-space region bounded by the two corner points, exactly as an interactive rubber-band selection would.
void	ClearSelection ()
	Clear the current selection on all representations.
vtkSelection *	GetCurrentSelection ()
	Get the current selection.
void	Start ()
	Start the interactor event loop.
void	Render () override
	Override to auto-reset camera on first render.

void	SetBackground (double r, double g, double b)
	Set/Get the background color of the renderer.
double *	GetBackground ()
	Set/Get the background color of the renderer.
void	SetBackground2 (double r, double g, double b)
	Set/Get the background color of the renderer.
double *	GetBackground2 ()
	Set/Get the background color of the renderer.
void	SetGradientBackground (bool val)
	Set/Get the background color of the renderer.
bool	GetGradientBackground ()
	Set/Get the background color of the renderer.

void	SetWindowSize (int w, int h)
	Set/Get the render window size and title.
int *	GetWindowSize ()
	Set/Get the render window size and title.
void	SetWindowTitle (const char *title)
	Set/Get the render window size and title.
const char *	GetWindowTitle ()
	Set/Get the render window size and title.

void	SetOrientationAxesVisibility (bool val)
	Show or hide the orientation axes marker in the lower-left corner of the render window.
bool	GetOrientationAxesVisibility ()
	Show or hide the orientation axes marker in the lower-left corner of the render window.

void	SetOrientationAxesInteractive (bool val)
	Set whether the orientation axes marker can be interactively moved and resized by the user.
bool	GetOrientationAxesInteractive ()
	Set whether the orientation axes marker can be interactively moved and resized by the user.

void	SetUseLightKit (bool val)
	Enable or disable the light kit.
bool	GetUseLightKit ()
	Enable or disable the light kit.

void	SetKeyLightIntensity (double val)
	Light kit parameters (forwarded to the internal vtkLightKit).
double	GetKeyLightIntensity ()
	Light kit parameters (forwarded to the internal vtkLightKit).
void	SetKeyToFillRatio (double val)
	Light kit parameters (forwarded to the internal vtkLightKit).
double	GetKeyToFillRatio ()
	Light kit parameters (forwarded to the internal vtkLightKit).
void	SetKeyToHeadRatio (double val)
	Light kit parameters (forwarded to the internal vtkLightKit).
double	GetKeyToHeadRatio ()
	Light kit parameters (forwarded to the internal vtkLightKit).
void	SetKeyToBackRatio (double val)
	Light kit parameters (forwarded to the internal vtkLightKit).
double	GetKeyToBackRatio ()
	Light kit parameters (forwarded to the internal vtkLightKit).
void	SetKeyLightWarmth (double val)
	Light kit parameters (forwarded to the internal vtkLightKit).
double	GetKeyLightWarmth ()
	Light kit parameters (forwarded to the internal vtkLightKit).
void	SetFillLightWarmth (double val)
	Light kit parameters (forwarded to the internal vtkLightKit).
double	GetFillLightWarmth ()
	Light kit parameters (forwarded to the internal vtkLightKit).
void	SetHeadLightWarmth (double val)
	Light kit parameters (forwarded to the internal vtkLightKit).
double	GetHeadLightWarmth ()
	Light kit parameters (forwarded to the internal vtkLightKit).
void	SetBackLightWarmth (double val)
	Light kit parameters (forwarded to the internal vtkLightKit).
double	GetBackLightWarmth ()
	Light kit parameters (forwarded to the internal vtkLightKit).
void	SetKeyLightAngle (double elevation, double azimuth)
	Light kit parameters (forwarded to the internal vtkLightKit).
double *	GetKeyLightAngle ()
	Light kit parameters (forwarded to the internal vtkLightKit).
void	SetFillLightAngle (double elevation, double azimuth)
	Light kit parameters (forwarded to the internal vtkLightKit).
double *	GetFillLightAngle ()
	Light kit parameters (forwarded to the internal vtkLightKit).
void	SetBackLightAngle (double elevation, double azimuth)
	Light kit parameters (forwarded to the internal vtkLightKit).
double *	GetBackLightAngle ()
	Light kit parameters (forwarded to the internal vtkLightKit).
void	SetMaintainLuminance (bool val)
	Light kit parameters (forwarded to the internal vtkLightKit).
bool	GetMaintainLuminance ()
	Light kit parameters (forwarded to the internal vtkLightKit).

void	AddLight (vtkLight *light)
	Add or remove individual lights from the renderer.
void	RemoveLight (vtkLight *light)
	Add or remove individual lights from the renderer.
void	RemoveAllLights ()
	Add or remove individual lights from the renderer.

void	SetInteractorStyle (vtkInteractorObserver *style)
	Install an interactor style of your own, for interaction the built-in modes do not cover – a 2D or terrain camera, or a vtkInteractorStyleManipulator configured with your own button bindings.
vtkInteractorObserver *	GetInteractorStyle ()
	Install an interactor style of your own, for interaction the built-in modes do not cover – a 2D or terrain camera, or a vtkInteractorStyleManipulator configured with your own button bindings.

void	SetSelectionFieldAssociation (int assoc)
	Field association for selection.
int	GetSelectionFieldAssociation ()
	Field association for selection.
void	SelectCells ()
	Field association for selection.
void	SelectPoints ()
	Field association for selection.
Public Member Functions inherited from vtkRenderViewBase
vtkRenderViewBase *	NewInstance () const
virtual vtkRenderer *	GetRenderer ()
	Gets the renderer for this view.
virtual void	SetRenderer (vtkRenderer *ren)
virtual vtkRenderWindow *	GetRenderWindow ()
	Get a handle to the render window.
virtual void	SetRenderWindow (vtkRenderWindow *win)
	Set the render window for this view.
virtual void	ResetCamera ()
	Updates the representations, then calls ResetCamera() on the renderer associated with this view.
virtual void	ResetCameraClippingRange ()
	Updates the representations, then calls ResetCameraClippingRange() on the renderer associated with this view.
virtual vtkRenderWindowInteractor *	GetInteractor ()
	The render window interactor.
virtual void	SetInteractor (vtkRenderWindowInteractor *)
	The render window interactor.
Public Member Functions inherited from vtkView
vtkView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	AddRepresentation (vtkDataRepresentation *rep)
	Adds the representation to the view.
void	SetRepresentation (vtkDataRepresentation *rep)
	Set the representation to the view.
vtkDataRepresentation *	AddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
	Convenience method which creates a simple representation with the connection and adds it to the view.
vtkDataRepresentation *	SetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
	Convenience method which sets the representation with the connection and adds it to the view.
vtkDataRepresentation *	AddRepresentationFromInput (vtkDataObject *input)
	Convenience method which creates a simple representation with the specified input and adds it to the view.
vtkDataRepresentation *	SetRepresentationFromInput (vtkDataObject *input)
	Convenience method which sets the representation to the specified input and adds it to the view.
void	RemoveRepresentation (vtkDataRepresentation *rep)
	Removes the representation from the view.
void	RemoveRepresentation (vtkAlgorithmOutput *rep)
	Removes any representation with this connection from the view.
void	RemoveAllRepresentations ()
	Removes all representations from the view.
int	GetNumberOfRepresentations ()
	Returns the number of representations from first port(0) in this view.
vtkDataRepresentation *	GetRepresentation (int index=0)
	The representation at a specified index.
bool	IsRepresentationPresent (vtkDataRepresentation *rep)
	Check to see if a representation is present in the view.
virtual void	Update ()
	Update the view.
virtual void	ApplyViewTheme (vtkViewTheme *theme)
	Apply a theme to the view.
vtkCommand *	GetObserver ()
	Returns the observer that the subclasses can use to listen to additional events.
void	RegisterProgress (vtkObject algorithm, const char message=nullptr)
	Meant for use by subclasses and vtkRepresentation subclasses.
void	UnRegisterProgress (vtkObject *algorithm)
	Unregister objects previously registered with RegisterProgress.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkStandardRenderView *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkStandardRenderView *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkRenderViewBase
static vtkRenderViewBase *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkRenderViewBase *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkView
static vtkView *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkView *	SafeDownCast (vtkObjectBase *o)
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkStandardRenderView ()
	~vtkStandardRenderView () override
void	ProcessEvents (vtkObject caller, unsigned long eventId, void callData) override
	Called to process events.
Protected Member Functions inherited from vtkRenderViewBase
	vtkRenderViewBase ()
	~vtkRenderViewBase () override
virtual void	PrepareForRendering ()
	Called by the view when the renderer is about to render.
	vtkView ()
	Meant for use by subclasses and vtkRepresentation subclasses.
	~vtkView () override
	Meant for use by subclasses and vtkRepresentation subclasses.
virtual vtkDataRepresentation *	CreateDefaultRepresentation (vtkAlgorithmOutput *conn)
	Create a default vtkDataRepresentation for the given vtkAlgorithmOutput.
virtual void	AddRepresentationInternal (vtkDataRepresentation *rep)
	Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed.
virtual void	RemoveRepresentationInternal (vtkDataRepresentation *rep)
	Meant for use by subclasses and vtkRepresentation subclasses.
virtual void	SetReuseSingleRepresentation (bool)
	True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls.
virtual bool	GetReuseSingleRepresentation ()
	Meant for use by subclasses and vtkRepresentation subclasses.
virtual void	ReuseSingleRepresentationOn ()
	Meant for use by subclasses and vtkRepresentation subclasses.
virtual void	ReuseSingleRepresentationOff ()
	Meant for use by subclasses and vtkRepresentation subclasses.
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=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)
enum	{ INTERACTION_MODE_3D = 0 , INTERACTION_MODE_SELECTION = 1 , INTERACTION_MODE_CUSTOM = 2 }
	Interaction mode constants. More...
void	SetInteractionMode (int mode)
	Interaction mode constants.
int	GetInteractionMode ()
	Interaction mode constants.
void	SetInteractionModeTo3D ()
	Interaction mode constants.
void	SetInteractionModeToSelection ()
	Interaction mode constants.
enum	{ SELECTION_MODE_SURFACE = 0 , SELECTION_MODE_FRUSTUM = 1 }
	Selection mode constants. More...
void	SetSelectionMode (int mode)
	Selection mode constants.
int	GetSelectionMode ()
	Selection mode constants.
void	SetSelectionModeToSurface ()
	Selection mode constants.
void	SetSelectionModeToFrustum ()
	Selection mode constants.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkRenderViewBase
vtkSmartPointer< vtkRenderer >	Renderer
vtkSmartPointer< vtkRenderWindow >	RenderWindow
bool	ReuseSingleRepresentation
	Meant for use by subclasses and vtkRepresentation subclasses.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Member Typedef Documentation

◆ Superclass

typedef vtkRenderViewBase vtkStandardRenderView::Superclass

Definition at line 62 of file vtkStandardRenderView.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Interaction mode constants.

INTERACTION_MODE_3D uses vtkInteractorStyleTrackballCamera (default). INTERACTION_MODE_SELECTION uses vtkInteractorStyleRubberBand3D for rubber-band selection. Mode switching is programmatic; applications typically expose it through a toolbar or keyboard shortcut. INTERACTION_MODE_CUSTOM reports that a style supplied through SetInteractorStyle() is installed; it cannot be selected directly.

The view owns one instance of each built-in style and switches between them, so any configuration applied to a style survives a mode change.

Enumerator
INTERACTION_MODE_3D
INTERACTION_MODE_SELECTION
INTERACTION_MODE_CUSTOM

Definition at line 212 of file vtkStandardRenderView.h.

◆ anonymous enum

anonymous enum

Selection mode constants.

SELECTION_MODE_SURFACE uses hardware picking (vtkHardwareSelector) to select visible cells/points on the surface. SELECTION_MODE_FRUSTUM selects all cells/points within the viewing frustum defined by the rubber-band rectangle.

Enumerator
SELECTION_MODE_SURFACE
SELECTION_MODE_FRUSTUM

Definition at line 255 of file vtkStandardRenderView.h.

Constructor & Destructor Documentation

◆ vtkStandardRenderView()

vtkStandardRenderView::vtkStandardRenderView ( )

protected

◆ ~vtkStandardRenderView()

vtkStandardRenderView::~vtkStandardRenderView ( )

overrideprotected

Member Function Documentation

◆ New()

vtkStandardRenderView * vtkStandardRenderView::New ( )

static

◆ IsTypeOf()

vtkTypeBool vtkStandardRenderView::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkStandardRenderView::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 vtkRenderViewBase.

◆ SafeDownCast()

vtkStandardRenderView * vtkStandardRenderView::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkStandardRenderView::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderViewBase.

◆ NewInstance()

vtkStandardRenderView * vtkStandardRenderView::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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 vtkRenderViewBase.

◆ GetMTime()

vtkMTimeType vtkStandardRenderView::GetMTime ( )

overridevirtual

The view stores its configuration on the renderer, render window, light kit and orientation marker widget rather than in its own ivars, so the modified time reported here is the latest of this object's own and theirs.

Note that this makes the view report scene changes too, since adding or removing a representation modifies the renderer.

Reimplemented from vtkObject.

◆ SetBackground()

void vtkStandardRenderView::SetBackground	(	double	r,
		double	g,
		double	b )

Set/Get the background color of the renderer.

SetBackground sets the bottom color of the gradient, SetBackground2 the top color.

◆ GetBackground()

double * vtkStandardRenderView::GetBackground ( )

Set/Get the background color of the renderer.

SetBackground sets the bottom color of the gradient, SetBackground2 the top color.

◆ SetBackground2()

void vtkStandardRenderView::SetBackground2	(	double	r,
		double	g,
		double	b )

Set/Get the background color of the renderer.

SetBackground sets the bottom color of the gradient, SetBackground2 the top color.

◆ GetBackground2()

double * vtkStandardRenderView::GetBackground2 ( )

Set/Get the background color of the renderer.

SetBackground sets the bottom color of the gradient, SetBackground2 the top color.

◆ SetGradientBackground()

void vtkStandardRenderView::SetGradientBackground ( bool val )

Set/Get the background color of the renderer.

SetBackground sets the bottom color of the gradient, SetBackground2 the top color.

◆ GetGradientBackground()

bool vtkStandardRenderView::GetGradientBackground ( )

Set/Get the background color of the renderer.

SetBackground sets the bottom color of the gradient, SetBackground2 the top color.

◆ SetWindowSize()

void vtkStandardRenderView::SetWindowSize	(	int	w,
		int	h )

Set/Get the render window size and title.

◆ GetWindowSize()

int * vtkStandardRenderView::GetWindowSize ( )

Set/Get the render window size and title.

◆ SetWindowTitle()

void vtkStandardRenderView::SetWindowTitle ( const char * title )

Set/Get the render window size and title.

◆ GetWindowTitle()

const char * vtkStandardRenderView::GetWindowTitle ( )

Set/Get the render window size and title.

◆ SetOrientationAxesVisibility()

void vtkStandardRenderView::SetOrientationAxesVisibility ( bool val )

Show or hide the orientation axes marker in the lower-left corner of the render window.

The marker shows the current camera orientation as an interactive XYZ axes triad. Default is on.

◆ GetOrientationAxesVisibility()

bool vtkStandardRenderView::GetOrientationAxesVisibility ( )

Show or hide the orientation axes marker in the lower-left corner of the render window.

The marker shows the current camera orientation as an interactive XYZ axes triad. Default is on.

◆ SetOrientationAxesInteractive()

void vtkStandardRenderView::SetOrientationAxesInteractive ( bool val )

Set whether the orientation axes marker can be interactively moved and resized by the user.

Default is off.

◆ GetOrientationAxesInteractive()

bool vtkStandardRenderView::GetOrientationAxesInteractive ( )

Set whether the orientation axes marker can be interactively moved and resized by the user.

Default is off.

◆ GetOrientationMarkerWidget()

vtkOrientationMarkerWidget * vtkStandardRenderView::GetOrientationMarkerWidget ( )

Provide access to the orientation marker widget for advanced usage.

◆ SetUseLightKit()

void vtkStandardRenderView::SetUseLightKit ( bool val )

Enable or disable the light kit.

When enabled, the renderer's existing lights are replaced by a professional 5-light rig (key, fill, headlight, and two back lights) managed by vtkLightKit. When disabled, the light kit lights are removed and the renderer reverts to its default single headlight. Default is off (single headlight).

◆ GetUseLightKit()

bool vtkStandardRenderView::GetUseLightKit ( )

Enable or disable the light kit.

When enabled, the renderer's existing lights are replaced by a professional 5-light rig (key, fill, headlight, and two back lights) managed by vtkLightKit. When disabled, the light kit lights are removed and the renderer reverts to its default single headlight. Default is off (single headlight).

◆ SetKeyLightIntensity()

void vtkStandardRenderView::SetKeyLightIntensity ( double val )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetKeyLightIntensity()

double vtkStandardRenderView::GetKeyLightIntensity ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ SetKeyToFillRatio()

void vtkStandardRenderView::SetKeyToFillRatio ( double val )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetKeyToFillRatio()

double vtkStandardRenderView::GetKeyToFillRatio ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ SetKeyToHeadRatio()

void vtkStandardRenderView::SetKeyToHeadRatio ( double val )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetKeyToHeadRatio()

double vtkStandardRenderView::GetKeyToHeadRatio ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ SetKeyToBackRatio()

void vtkStandardRenderView::SetKeyToBackRatio ( double val )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetKeyToBackRatio()

double vtkStandardRenderView::GetKeyToBackRatio ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ SetKeyLightWarmth()

void vtkStandardRenderView::SetKeyLightWarmth ( double val )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetKeyLightWarmth()

double vtkStandardRenderView::GetKeyLightWarmth ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ SetFillLightWarmth()

void vtkStandardRenderView::SetFillLightWarmth ( double val )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetFillLightWarmth()

double vtkStandardRenderView::GetFillLightWarmth ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ SetHeadLightWarmth()

void vtkStandardRenderView::SetHeadLightWarmth ( double val )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetHeadLightWarmth()

double vtkStandardRenderView::GetHeadLightWarmth ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ SetBackLightWarmth()

void vtkStandardRenderView::SetBackLightWarmth ( double val )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetBackLightWarmth()

double vtkStandardRenderView::GetBackLightWarmth ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ SetKeyLightAngle()

void vtkStandardRenderView::SetKeyLightAngle	(	double	elevation,
		double	azimuth )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetKeyLightAngle()

double * vtkStandardRenderView::GetKeyLightAngle ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ SetFillLightAngle()

void vtkStandardRenderView::SetFillLightAngle	(	double	elevation,
		double	azimuth )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetFillLightAngle()

double * vtkStandardRenderView::GetFillLightAngle ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ SetBackLightAngle()

void vtkStandardRenderView::SetBackLightAngle	(	double	elevation,
		double	azimuth )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetBackLightAngle()

double * vtkStandardRenderView::GetBackLightAngle ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ SetMaintainLuminance()

void vtkStandardRenderView::SetMaintainLuminance ( bool val )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetMaintainLuminance()

bool vtkStandardRenderView::GetMaintainLuminance ( )

Light kit parameters (forwarded to the internal vtkLightKit).

These only take effect when the light kit is enabled.

KeyLightIntensity controls the overall brightness (default 0.75). KeyToFillRatio, KeyToHeadRatio, and KeyToBackRatio control the relative intensity of the fill, headlight, and back lights compared to the key light (defaults 3.0, 3.0, 3.5).

Warmth values control color temperature on a 0-1 scale where 0 is cold blue, 0.5 is neutral white, and 1 is warm sunset (defaults: key 0.6, fill 0.4, head 0.5, back 0.5).

KeyLightAngle and FillLightAngle position the key and fill lights by elevation and azimuth in degrees (defaults: key 50/-10, fill -75/-10). BackLightAngle positions both back lights symmetrically.

MaintainLuminance compensates for perceived brightness differences across color temperatures (default off).

◆ GetLightKit()

vtkLightKit * vtkStandardRenderView::GetLightKit ( )

Provide access to the internal light kit for advanced usage.

◆ AddLight()

void vtkStandardRenderView::AddLight ( vtkLight * light )

Add or remove individual lights from the renderer.

These methods work regardless of whether the light kit is enabled. When a light kit is active, manually added lights supplement the light kit lights.

◆ RemoveLight()

void vtkStandardRenderView::RemoveLight ( vtkLight * light )

Add or remove individual lights from the renderer.

These methods work regardless of whether the light kit is enabled. When a light kit is active, manually added lights supplement the light kit lights.

◆ RemoveAllLights()

void vtkStandardRenderView::RemoveAllLights ( )

Add or remove individual lights from the renderer.

These methods work regardless of whether the light kit is enabled. When a light kit is active, manually added lights supplement the light kit lights.

◆ SetInteractionMode()

void vtkStandardRenderView::SetInteractionMode ( int mode )

Interaction mode constants.

INTERACTION_MODE_3D uses vtkInteractorStyleTrackballCamera (default). INTERACTION_MODE_SELECTION uses vtkInteractorStyleRubberBand3D for rubber-band selection. Mode switching is programmatic; applications typically expose it through a toolbar or keyboard shortcut. INTERACTION_MODE_CUSTOM reports that a style supplied through SetInteractorStyle() is installed; it cannot be selected directly.

The view owns one instance of each built-in style and switches between them, so any configuration applied to a style survives a mode change.

◆ GetInteractionMode()

int vtkStandardRenderView::GetInteractionMode ( )

Interaction mode constants.

INTERACTION_MODE_3D uses vtkInteractorStyleTrackballCamera (default). INTERACTION_MODE_SELECTION uses vtkInteractorStyleRubberBand3D for rubber-band selection. Mode switching is programmatic; applications typically expose it through a toolbar or keyboard shortcut. INTERACTION_MODE_CUSTOM reports that a style supplied through SetInteractorStyle() is installed; it cannot be selected directly.

The view owns one instance of each built-in style and switches between them, so any configuration applied to a style survives a mode change.

◆ SetInteractionModeTo3D()

void vtkStandardRenderView::SetInteractionModeTo3D ( )

inline

Interaction mode constants.

INTERACTION_MODE_3D uses vtkInteractorStyleTrackballCamera (default). INTERACTION_MODE_SELECTION uses vtkInteractorStyleRubberBand3D for rubber-band selection. Mode switching is programmatic; applications typically expose it through a toolbar or keyboard shortcut. INTERACTION_MODE_CUSTOM reports that a style supplied through SetInteractorStyle() is installed; it cannot be selected directly.

The view owns one instance of each built-in style and switches between them, so any configuration applied to a style survives a mode change.

Definition at line 220 of file vtkStandardRenderView.h.

◆ SetInteractionModeToSelection()

void vtkStandardRenderView::SetInteractionModeToSelection ( )

inline

Interaction mode constants.

INTERACTION_MODE_3D uses vtkInteractorStyleTrackballCamera (default). INTERACTION_MODE_SELECTION uses vtkInteractorStyleRubberBand3D for rubber-band selection. Mode switching is programmatic; applications typically expose it through a toolbar or keyboard shortcut. INTERACTION_MODE_CUSTOM reports that a style supplied through SetInteractorStyle() is installed; it cannot be selected directly.

The view owns one instance of each built-in style and switches between them, so any configuration applied to a style survives a mode change.

Definition at line 221 of file vtkStandardRenderView.h.

◆ SetInteractorStyle()

void vtkStandardRenderView::SetInteractorStyle ( vtkInteractorObserver * style )

Install an interactor style of your own, for interaction the built-in modes do not cover – a 2D or terrain camera, or a vtkInteractorStyleManipulator configured with your own button bindings.

The view holds a reference to the style and reports INTERACTION_MODE_CUSTOM until a built-in mode is selected again, at which point the custom style is remembered and can be restored by setting it once more. Passing nullptr returns to INTERACTION_MODE_3D.

To drive selection from a custom style, call SelectRegion() from its event handling. The view does not interpret events from a style it does not know.

GetInteractorStyle() returns the style currently installed on the interactor, built-in or custom.

◆ GetInteractorStyle()

vtkInteractorObserver * vtkStandardRenderView::GetInteractorStyle ( )

Install an interactor style of your own, for interaction the built-in modes do not cover – a 2D or terrain camera, or a vtkInteractorStyleManipulator configured with your own button bindings.

The view holds a reference to the style and reports INTERACTION_MODE_CUSTOM until a built-in mode is selected again, at which point the custom style is remembered and can be restored by setting it once more. Passing nullptr returns to INTERACTION_MODE_3D.

To drive selection from a custom style, call SelectRegion() from its event handling. The view does not interpret events from a style it does not know.

GetInteractorStyle() returns the style currently installed on the interactor, built-in or custom.

◆ SetSelectionMode()

void vtkStandardRenderView::SetSelectionMode ( int mode )

Selection mode constants.

SELECTION_MODE_SURFACE uses hardware picking (vtkHardwareSelector) to select visible cells/points on the surface. SELECTION_MODE_FRUSTUM selects all cells/points within the viewing frustum defined by the rubber-band rectangle.

◆ GetSelectionMode()

int vtkStandardRenderView::GetSelectionMode ( )

Selection mode constants.

SELECTION_MODE_SURFACE uses hardware picking (vtkHardwareSelector) to select visible cells/points on the surface. SELECTION_MODE_FRUSTUM selects all cells/points within the viewing frustum defined by the rubber-band rectangle.

◆ SetSelectionModeToSurface()

void vtkStandardRenderView::SetSelectionModeToSurface ( )

inline

Selection mode constants.

SELECTION_MODE_SURFACE uses hardware picking (vtkHardwareSelector) to select visible cells/points on the surface. SELECTION_MODE_FRUSTUM selects all cells/points within the viewing frustum defined by the rubber-band rectangle.

Definition at line 262 of file vtkStandardRenderView.h.

◆ SetSelectionModeToFrustum()

void vtkStandardRenderView::SetSelectionModeToFrustum ( )

inline

Selection mode constants.

SELECTION_MODE_SURFACE uses hardware picking (vtkHardwareSelector) to select visible cells/points on the surface. SELECTION_MODE_FRUSTUM selects all cells/points within the viewing frustum defined by the rubber-band rectangle.

Definition at line 263 of file vtkStandardRenderView.h.

◆ SetSelectionFieldAssociation()

void vtkStandardRenderView::SetSelectionFieldAssociation ( int assoc )

Field association for selection.

Determines whether cells or points are selected. Uses vtkDataObject::FIELD_ASSOCIATION_CELLS (default) or vtkDataObject::FIELD_ASSOCIATION_POINTS.

◆ GetSelectionFieldAssociation()

int vtkStandardRenderView::GetSelectionFieldAssociation ( )

Field association for selection.

Determines whether cells or points are selected. Uses vtkDataObject::FIELD_ASSOCIATION_CELLS (default) or vtkDataObject::FIELD_ASSOCIATION_POINTS.

◆ SelectCells()

void vtkStandardRenderView::SelectCells ( )

Field association for selection.

Determines whether cells or points are selected. Uses vtkDataObject::FIELD_ASSOCIATION_CELLS (default) or vtkDataObject::FIELD_ASSOCIATION_POINTS.

◆ SelectPoints()

void vtkStandardRenderView::SelectPoints ( )

Field association for selection.

Determines whether cells or points are selected. Uses vtkDataObject::FIELD_ASSOCIATION_CELLS (default) or vtkDataObject::FIELD_ASSOCIATION_POINTS.

◆ SelectRegion()

void vtkStandardRenderView::SelectRegion	(	int	x0,
		int	y0,
		int	x1,
		int	y1,
		bool	extend = false )

Select the screen-space region bounded by the two corner points, exactly as an interactive rubber-band selection would.

The corners are given in display coordinates and may be in any order; the region is normalized and clamped to the renderer. A degenerate region (a click) is expanded slightly so that it still picks.

The selection honors the current selection mode and field association, is applied to every representation, becomes the current selection, and fires SelectionChangedEvent. When extend is true it adds to the existing selection instead of replacing it.

This is the entry point the built-in rubber-band interaction uses, and the supported way for application code or a custom interactor style to drive selection without synthesizing interactor events.

◆ ClearSelection()

void vtkStandardRenderView::ClearSelection ( )

Clear the current selection on all representations.

◆ GetCurrentSelection()

vtkSelection * vtkStandardRenderView::GetCurrentSelection ( )

Get the current selection.

This is the combined selection produced by the last interactive or programmatic selection operation, containing nodes for all picked actors. Returns nullptr if no selection has been made.

After a selection is made, the view fires SelectionChangedEvent with the vtkSelection pointer as call data. Observers can retrieve the selection from this method or from the call data.

◆ Start()

void vtkStandardRenderView::Start ( )

Start the interactor event loop.

Calls Render() first.

◆ Render()

void vtkStandardRenderView::Render ( )

overridevirtual

Override to auto-reset camera on first render.

Reimplemented from vtkRenderViewBase.

◆ ProcessEvents()

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

overrideprotectedvirtual

Called to process events.

The superclass processes selection changed events from its representations. This may be overridden by subclasses to process additional events.

Reimplemented from vtkView.

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

Views/Rendering/vtkStandardRenderView.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkStandardRenderView()

◆ ~vtkStandardRenderView()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetMTime()

◆ SetBackground()

◆ GetBackground()

◆ SetBackground2()

◆ GetBackground2()

◆ SetGradientBackground()

◆ GetGradientBackground()

◆ SetWindowSize()

◆ GetWindowSize()

◆ SetWindowTitle()

◆ GetWindowTitle()

◆ SetOrientationAxesVisibility()

◆ GetOrientationAxesVisibility()

◆ SetOrientationAxesInteractive()

◆ GetOrientationAxesInteractive()

◆ GetOrientationMarkerWidget()

◆ SetUseLightKit()

◆ GetUseLightKit()

◆ SetKeyLightIntensity()

◆ GetKeyLightIntensity()

◆ SetKeyToFillRatio()

◆ GetKeyToFillRatio()

◆ SetKeyToHeadRatio()

◆ GetKeyToHeadRatio()

◆ SetKeyToBackRatio()

◆ GetKeyToBackRatio()

◆ SetKeyLightWarmth()

◆ GetKeyLightWarmth()

◆ SetFillLightWarmth()

◆ GetFillLightWarmth()

◆ SetHeadLightWarmth()

◆ GetHeadLightWarmth()

◆ SetBackLightWarmth()

◆ GetBackLightWarmth()

◆ SetKeyLightAngle()

◆ GetKeyLightAngle()

◆ SetFillLightAngle()

◆ GetFillLightAngle()

◆ SetBackLightAngle()

◆ GetBackLightAngle()

◆ SetMaintainLuminance()

◆ GetMaintainLuminance()

◆ GetLightKit()

◆ AddLight()

◆ RemoveLight()

◆ RemoveAllLights()

◆ SetInteractionMode()

◆ GetInteractionMode()

◆ SetInteractionModeTo3D()

◆ SetInteractionModeToSelection()

◆ SetInteractorStyle()

◆ GetInteractorStyle()

◆ SetSelectionMode()

◆ GetSelectionMode()

◆ SetSelectionModeToSurface()

◆ SetSelectionModeToFrustum()

◆ SetSelectionFieldAssociation()

◆ GetSelectionFieldAssociation()