abstract superclass for all actors, volumes and annotations More...

#include <vtkProp.h>

Inheritance diagram for vtkProp:

Collaboration diagram for vtkProp:

Public Types
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.

vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	Pick ()
	Method fires PickEvent if the prop is picked.

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.

virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.

virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.

virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.

virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.

virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers


virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.

virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.


virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.

virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.

virtual void	PickableOn ()
	Set/Get the pickable instance variable.

virtual void	PickableOff ()
	Set/Get the pickable instance variable.


virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.

virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.


virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().


virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).


virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.


virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.


virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.


virtual int	GetNumberOfConsumers ()
	Get the number of consumers.


void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.


virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.

virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.


virtual bool	IsRenderingTranslucentPolygonalGeometry ()

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.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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 std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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 vtkTypeBool	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.

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

	vtkProp ()

	~vtkProp () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTypeBool	Visibility

vtkTypeBool	Pickable

vtkTypeBool	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

vtkShaderProperty *	ShaderProperty

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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

abstract superclass for all actors, volumes and annotations

vtkProp is an abstract superclass for any objects that can exist in a rendered scene (either 2D or 3D). Instances of vtkProp may respond to various render methods (e.g., RenderOpaqueGeometry()). vtkProp also defines the API for picking, LOD manipulation, and common instance variables that control visibility, picking, and dragging.

See also: vtkActor2D vtkActor vtkVolume vtkProp3D

Events:: vtkCommand::PickEvent

Examples:: vtkProp (Examples)

Online Examples:

ImageRegion

Tests:: vtkProp (Tests)

Definition at line 65 of file vtkProp.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkProp::Superclass

Definition at line 68 of file vtkProp.h.

Constructor & Destructor Documentation

◆ vtkProp()

vtkProp::vtkProp ( )

protected

◆ ~vtkProp()

vtkProp::~vtkProp ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkProp::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkProp::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 vtkObjectBase.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkProp::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkProp * vtkProp::NewInstance ( ) const

◆ PrintSelf()

void vtkProp::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 vtkObject.

Reimplemented in vtkXYPlotRepresentation, vtkQWidgetRepresentation, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkResliceCursorActor, vtkResliceCursorLineRepresentation, vtkResliceCursorRepresentation, vtkResliceCursorThickLineRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTensorRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, vtkWidgetRepresentation, vtkProp3DAxisFollower, vtkRadialGridActor2D, vtkScalarBarActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkProp3D, vtkProp3DFollower, vtkPropAssembly, vtkSkybox, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, vtkVolume, vtkScaledTextActor, vtkQuadricLODActor, vtkVRControlsHelper, vtkVRFollower, vtkVRMenuRepresentation, vtkVRPanelRepresentation, vtkWebGPUActor, and vtkZSpaceRayActor.

◆ GetActors()

virtual void vtkProp::GetActors ( vtkPropCollection * )

inlinevirtual

For some exporters and other other operations we must be able to collect all the actors or volumes.

These methods are used in that process.

Definition at line 76 of file vtkProp.h.

◆ GetActors2D()

virtual void vtkProp::GetActors2D ( vtkPropCollection * )

inlinevirtual

◆ GetVolumes()

virtual void vtkProp::GetVolumes ( vtkPropCollection * )

inlinevirtual

Reimplemented in vtkWidgetRepresentation, vtkAssembly, vtkLODProp3D, and vtkVolume.

Definition at line 78 of file vtkProp.h.

◆ SetVisibility()

virtual void vtkProp::SetVisibility ( vtkTypeBool )

virtual

Set/Get visibility of this vtkProp.

Initial value is true.

Reimplemented in vtkXYPlotRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkSphereHandleRepresentation, and vtkScalarBarRepresentation.

◆ GetVisibility()

virtual vtkTypeBool vtkProp::GetVisibility ( )

virtual

Set/Get visibility of this vtkProp.

Initial value is true.

Reimplemented in vtkXYPlotRepresentation, and vtkScalarBarRepresentation.

◆ VisibilityOn()

virtual void vtkProp::VisibilityOn ( )

virtual

Set/Get visibility of this vtkProp.

Initial value is true.

◆ VisibilityOff()

virtual void vtkProp::VisibilityOff ( )

virtual

Set/Get visibility of this vtkProp.

Initial value is true.

◆ SetPickable()

virtual void vtkProp::SetPickable ( vtkTypeBool )

virtual

Set/Get the pickable instance variable.

This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.

◆ GetPickable()

virtual vtkTypeBool vtkProp::GetPickable ( )

virtual

Set/Get the pickable instance variable.

This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.

◆ PickableOn()

virtual void vtkProp::PickableOn ( )

virtual

Set/Get the pickable instance variable.

This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.

◆ PickableOff()

virtual void vtkProp::PickableOff ( )

virtual

Set/Get the pickable instance variable.

This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.

◆ Pick()

virtual void vtkProp::Pick ( )

virtual

Method fires PickEvent if the prop is picked.

◆ SetDragable()

virtual void vtkProp::SetDragable ( vtkTypeBool )

virtual

Set/Get the value of the dragable instance variable.

This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.

◆ GetDragable()

virtual vtkTypeBool vtkProp::GetDragable ( )

virtual

Set/Get the value of the dragable instance variable.

This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.

◆ DragableOn()

virtual void vtkProp::DragableOn ( )

virtual

Set/Get the value of the dragable instance variable.

This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.

◆ DragableOff()

virtual void vtkProp::DragableOff ( )

virtual

Set/Get the value of the dragable instance variable.

This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.

◆ GetRedrawMTime()

virtual vtkMTimeType vtkProp::GetRedrawMTime ( )

inlinevirtual

Return the mtime of anything that would cause the rendered image to appear differently.

Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, textures etc.

Reimplemented in vtkAxesActor, vtkActor, vtkImageSlice, vtkVolume, and vtkImageStack.

Definition at line 126 of file vtkProp.h.

◆ SetUseBounds()

virtual void vtkProp::SetUseBounds ( bool )

virtual

In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

Initial value is true.

◆ GetUseBounds()

virtual bool vtkProp::GetUseBounds ( )

virtual

In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

Initial value is true.

◆ UseBoundsOn()

virtual void vtkProp::UseBoundsOn ( )

virtual

In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

Initial value is true.

◆ UseBoundsOff()

virtual void vtkProp::UseBoundsOff ( )

virtual

In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

Initial value is true.

◆ GetBounds()

virtual double * vtkProp::GetBounds ( )

inlinevirtual

Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

in world coordinates. NULL means that the bounds are not defined.

Reimplemented in vtkQWidgetRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAxesTransformRepresentation, vtkBoxRepresentation, vtkCamera3DRepresentation, vtkCameraOrientationRepresentation, vtkCoordinateFrameRepresentation, vtkCurveRepresentation, vtkDisplaySizedImplicitPlaneRepresentation, vtkDistanceRepresentation3D, vtkFinitePlaneRepresentation, vtkImplicitAnnulusRepresentation, vtkImplicitConeRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitFrustumRepresentation, vtkImplicitPlaneRepresentation, vtkLightRepresentation, vtkLineRepresentation, vtkMeasurementCubeHandleRepresentation3D, vtkOrientationRepresentation, vtkOrientedGlyphContourRepresentation, vtkParallelopipedRepresentation, vtkPointCloudRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkResliceCursorActor, vtkResliceCursorLineRepresentation, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTensorRepresentation, vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, vtkWidgetRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkCubeAxesActor, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkPolarAxesActor, vtkActor, vtkAssembly, vtkBillboardTextActor3D, vtkCameraActor, vtkFlagpoleLabel, vtkFlagpoleLabel, vtkImageActor, vtkImageSlice, vtkLightActor, vtkLODProp3D, vtkProp3DFollower, vtkPropAssembly, vtkSkybox, vtkSkybox, vtkTextActor3D, vtkVolume, vtkImageStack, vtkMultiVolume, vtkOpenGLAvatar, vtkActor, vtkBillboardTextActor3D, vtkFlagpoleLabel, vtkProp3D, and vtkSkybox.

Definition at line 144 of file vtkProp.h.

◆ ShallowCopy()

virtual void vtkProp::ShallowCopy ( vtkProp * prop )

virtual

Shallow copy of this vtkProp.

Reimplemented in vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkButtonRepresentation, vtkCameraOrientationRepresentation, vtkConstrainedPointHandleRepresentation, vtkHandleRepresentation, vtkMeasurementCubeHandleRepresentation3D, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkSphereHandleRepresentation, vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, vtkWidgetRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor2D, vtkAxisFollower, vtkCaptionActor2D, vtkLeaderActor2D, vtkLegendBoxActor, vtkProp3DAxisFollower, vtkScalarBarActor, vtkActor, vtkActor2D, vtkAssembly, vtkFollower, vtkImageSlice, vtkLODProp3D, vtkProp3D, vtkProp3DFollower, vtkPropAssembly, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, vtkVolume, vtkImageStack, vtkLODActor, vtkQuadricLODActor, and vtkMultiVolume.

◆ InitPathTraversal()

virtual void vtkProp::InitPathTraversal ( )

virtual

vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

The following methods interface with the picking classes and return "pick paths". A pick path is a hierarchical, ordered list of props that form an assembly. Most often, when a vtkProp is picked, its path consists of a single node (i.e., the prop). However, classes like vtkAssembly and vtkPropAssembly can return more than one path, each path being several layers deep. (See vtkAssemblyPath for more information.) To use these methods - first invoke InitPathTraversal() followed by repeated calls to GetNextPath(). GetNextPath() returns a NULL pointer when the list is exhausted.

Reimplemented in vtkAssembly, vtkProp3D, vtkProp3DFollower, vtkPropAssembly, and vtkImageStack.

◆ GetNextPath()

virtual vtkAssemblyPath * vtkProp::GetNextPath ( )

virtual

vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

The following methods interface with the picking classes and return "pick paths". A pick path is a hierarchical, ordered list of props that form an assembly. Most often, when a vtkProp is picked, its path consists of a single node (i.e., the prop). However, classes like vtkAssembly and vtkPropAssembly can return more than one path, each path being several layers deep. (See vtkAssemblyPath for more information.) To use these methods - first invoke InitPathTraversal() followed by repeated calls to GetNextPath(). GetNextPath() returns a NULL pointer when the list is exhausted.

Reimplemented in vtkAssembly, vtkProp3DFollower, vtkPropAssembly, and vtkImageStack.

◆ GetNumberOfPaths()

virtual int vtkProp::GetNumberOfPaths ( )

inlinevirtual

vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

The following methods interface with the picking classes and return "pick paths". A pick path is a hierarchical, ordered list of props that form an assembly. Most often, when a vtkProp is picked, its path consists of a single node (i.e., the prop). However, classes like vtkAssembly and vtkPropAssembly can return more than one path, each path being several layers deep. (See vtkAssemblyPath for more information.) To use these methods - first invoke InitPathTraversal() followed by repeated calls to GetNextPath(). GetNextPath() returns a NULL pointer when the list is exhausted.

Reimplemented in vtkAssembly, vtkPropAssembly, and vtkImageStack.

Definition at line 166 of file vtkProp.h.

◆ PokeMatrix()

virtual void vtkProp::PokeMatrix ( vtkMatrix4x4 * vtkNotUsedmatrix )

inlinevirtual

These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.

Generally used only for picking. See vtkProp3D for more information.

Definition at line 174 of file vtkProp.h.

◆ GetMatrix()

virtual vtkMatrix4x4 * vtkProp::GetMatrix ( )

inlinevirtual

Reimplemented in vtkProp3D, and vtkMultiVolume.

Definition at line 175 of file vtkProp.h.

◆ GetPropertyKeys()

virtual vtkInformation * vtkProp::GetPropertyKeys ( )

virtual

Set/Get property keys.

Property keys can be digest by some rendering passes. For instance, the user may mark a prop as a shadow caster for a shadow mapping render pass. Keys are documented in render pass classes. Initial value is NULL.

◆ SetPropertyKeys()

virtual void vtkProp::SetPropertyKeys ( vtkInformation * keys )

virtual

Set/Get property keys.

Property keys can be digest by some rendering passes. For instance, the user may mark a prop as a shadow caster for a shadow mapping render pass. Keys are documented in render pass classes. Initial value is NULL.

◆ HasKeys()

virtual bool vtkProp::HasKeys ( vtkInformation * requiredKeys )

virtual

Tells if the prop has all the required keys.

Precondition: keys_can_be_null: requiredKeys==0 || requiredKeys!=0

◆ GeneralTextureUnit()

static vtkInformationIntegerKey * vtkProp::GeneralTextureUnit ( )

static

Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.

The new OpenGL design is more mapper centric. Some classes push a texture and then assume a mapper will use it. The new design wants explicit communication of when a texture is being used. This key can be used to pass that information down to a mapper.

◆ GeneralTextureTransform()

static vtkInformationDoubleVectorKey * vtkProp::GeneralTextureTransform ( )

static

Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.

The new OpenGL design is more mapper centric. Some classes push a texture and then assume a mapper will use it. The new design wants explicit communication of when a texture is being used. This key can be used to pass that information down to a mapper.

◆ RenderOpaqueGeometry()

virtual int vtkProp::RenderOpaqueGeometry ( vtkViewport * )

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.

There are four key render methods in vtk and they correspond to four different points in the rendering cycle. Any given prop may implement one or more of these methods. The first method is intended for rendering all opaque geometry. The second method is intended for rendering all translucent polygonal geometry. The third one is intended for rendering all translucent volumetric geometry. Most of the volume rendering mappers draw their results during this third method. The last method is to render any 2D annotation or overlays. Each of these methods return an integer value indicating whether or not this render method was applied to this data.

Reimplemented in vtkXYPlotRepresentation, vtkQWidgetRepresentation, vtkAngleRepresentation3D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCamera3DRepresentation, vtkCameraOrientationRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCompassRepresentation, vtkCoordinateFrameRepresentation, vtkCurveRepresentation, vtkDisplaySizedImplicitPlaneRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkFinitePlaneRepresentation, vtkImplicitAnnulusRepresentation, vtkImplicitConeRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitFrustumRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkMagnifierRepresentation, vtkOrientationRepresentation, vtkPlaybackRepresentation, vtkProgressBarRepresentation, vtkProp3DButtonRepresentation, vtkScalarBarRepresentation, vtkSphereRepresentation, vtkTensorProbeRepresentation, vtkTensorRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, vtkAxisGridActorPrivate, vtkBarChartActor, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkLegendScaleActor, vtkParallelCoordinatesActor, vtkPieChartActor, vtkPolarAxesActor, vtkPolarAxesActor2D, vtkRadialGridActor2D, vtkSpiderPlotActor, vtkXYPlotActor, vtkVRControlsHelper, vtkVRPanelRepresentation, vtkAssembly, vtkPropAssembly, vtk3DCursorRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAxesTransformRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkLightRepresentation, vtkMeasurementCubeHandleRepresentation3D, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPointCloudRepresentation, vtkPointHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkResliceCursorActor, vtkResliceCursorLineRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkAxisActor2D, vtkCaptionActor2D, vtkCornerAnnotation, vtkLeaderActor2D, vtkLegendBoxActor, vtkProp3DAxisFollower, vtkScalarBarActor, vtkActor, vtkActor2D, vtkCameraActor, vtkFollower, vtkImageSlice, vtkLightActor, vtkLODProp3D, vtkProp3DFollower, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, vtkImageStack, vtkContourRepresentation, vtkBillboardTextActor3D, vtkFlagpoleLabel, and vtkOpenGLAvatar.

Definition at line 235 of file vtkProp.h.

◆ RenderTranslucentPolygonalGeometry()

virtual int vtkProp::RenderTranslucentPolygonalGeometry ( vtkViewport * )

inlinevirtual

Definition at line 236 of file vtkProp.h.

◆ RenderVolumetricGeometry()

virtual int vtkProp::RenderVolumetricGeometry ( vtkViewport * )

inlinevirtual

Reimplemented in vtkProp3DButtonRepresentation, vtkAssembly, vtkPropAssembly, vtkProp3DAxisFollower, vtkLODProp3D, vtkProp3DFollower, vtkVolume, and vtkMultiVolume.

Definition at line 237 of file vtkProp.h.

◆ RenderOverlay()

virtual int vtkProp::RenderOverlay ( vtkViewport * )

inlinevirtual

Reimplemented in vtkXYPlotRepresentation, vtkBorderRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCurveRepresentation, vtkLogoRepresentation, vtkMagnifierRepresentation, vtkPlaybackRepresentation, vtkPointCloudRepresentation, vtkProgressBarRepresentation, vtkScalarBarRepresentation, vtkSphereRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation2D, vtkArcGridActorPrivate, vtkBarChartActor, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkLegendScaleActor, vtkParallelCoordinatesActor, vtkPieChartActor, vtkPolarAxesActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkVRMenuRepresentation, vtkPropAssembly, vtkAffineRepresentation2D, vtkAngleRepresentation2D, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkCheckerboardRepresentation, vtkCompassRepresentation, vtkConstrainedPointHandleRepresentation, vtkDistanceRepresentation2D, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPointHandleRepresentation2D, vtkRectilinearWipeRepresentation, vtkResliceCursorLineRepresentation, vtkSliderRepresentation2D, vtkAxesActor, vtkAxisActor, vtkAxisActor2D, vtkCaptionActor2D, vtkCornerAnnotation, vtkLeaderActor2D, vtkLegendBoxActor, vtkPolarAxesActor2D, vtkRadialGridActor2D, vtkScalarBarActor, vtkContextActor, vtkOpenGLContextActor, vtkActor2D, vtkImageSlice, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, vtkImageStack, vtkOpenGLTextActor, and vtkContourRepresentation.

Definition at line 238 of file vtkProp.h.

◆ RenderFilteredOpaqueGeometry()

virtual bool vtkProp::RenderFilteredOpaqueGeometry	(	vtkViewport *	v,
		vtkInformation *	requiredKeys
	)

virtual

Render the opaque geometry only if the prop has all the requiredKeys.

This is recursive for composite props like vtkAssembly. An implementation is provided in vtkProp but each composite prop must override it. It returns if the rendering was performed.

Precondition: v_exists: v!=0; keys_can_be_null: requiredKeys==0 || requiredKeys!=0

◆ RenderFilteredTranslucentPolygonalGeometry()

virtual bool vtkProp::RenderFilteredTranslucentPolygonalGeometry	(	vtkViewport *	v,
		vtkInformation *	requiredKeys
	)

virtual

Render the translucent polygonal geometry only if the prop has all the requiredKeys.

This is recursive for composite props like vtkAssembly. An implementation is provided in vtkProp but each composite prop must override it. It returns if the rendering was performed.

Precondition: v_exists: v!=0; keys_can_be_null: requiredKeys==0 || requiredKeys!=0

◆ RenderFilteredVolumetricGeometry()

virtual bool vtkProp::RenderFilteredVolumetricGeometry	(	vtkViewport *	v,
		vtkInformation *	requiredKeys
	)

virtual

Render the volumetric geometry only if the prop has all the requiredKeys.

This is recursive for composite props like vtkAssembly. An implementation is provided in vtkProp but each composite prop must override it. It returns if the rendering was performed.

Precondition: v_exists: v!=0; keys_can_be_null: requiredKeys==0 || requiredKeys!=0

◆ RenderFilteredOverlay()

virtual bool vtkProp::RenderFilteredOverlay	(	vtkViewport *	v,
		vtkInformation *	requiredKeys
	)

virtual

Render in the overlay of the viewport only if the prop has all the requiredKeys.

This is recursive for composite props like vtkAssembly. An implementation is provided in vtkProp but each composite prop must override it. It returns if the rendering was performed.

Precondition: v_exists: v!=0; keys_can_be_null: requiredKeys==0 || requiredKeys!=0

◆ HasTranslucentPolygonalGeometry()

virtual vtkTypeBool vtkProp::HasTranslucentPolygonalGeometry ( )

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.

A simple prop that has some translucent polygonal geometry will return true. A composite prop (like vtkAssembly) that has at least one sub-prop that has some translucent polygonal geometry will return true. Default implementation return false.

Reimplemented in vtkXYPlotRepresentation, vtkQWidgetRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAngleRepresentation3D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCamera3DRepresentation, vtkCameraOrientationRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkCoordinateFrameRepresentation, vtkCurveRepresentation, vtkDisplaySizedImplicitPlaneRepresentation, vtkFinitePlaneRepresentation, vtkImplicitAnnulusRepresentation, vtkImplicitConeRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitFrustumRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkMagnifierRepresentation, vtkMeasurementCubeHandleRepresentation3D, vtkOrientationRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPlaybackRepresentation, vtkPointCloudRepresentation, vtkPointHandleRepresentation3D, vtkProgressBarRepresentation, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkResliceCursorActor, vtkResliceCursorLineRepresentation, vtkScalarBarRepresentation, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTensorRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, vtkWidgetRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkAxisActor2D, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkLeaderActor2D, vtkLegendBoxActor, vtkParallelCoordinatesActor, vtkPieChartActor, vtkPolarAxesActor2D, vtkRadialGridActor2D, vtkScalarBarActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkActor, vtkActor2D, vtkAssembly, vtkBillboardTextActor3D, vtkCameraActor, vtkFlagpoleLabel, vtkImageActor, vtkImageSlice, vtkLightActor, vtkLODProp3D, vtkProp3DFollower, vtkPropAssembly, vtkTextActor, vtkTextActor3D, vtkImageStack, vtkVRControlsHelper, vtkVRMenuRepresentation, vtkVRPanelRepresentation, vtkWebGPUActor, and vtkContourRepresentation.

Definition at line 299 of file vtkProp.h.

◆ HasOpaqueGeometry()

virtual vtkTypeBool vtkProp::HasOpaqueGeometry ( )

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.

A simple prop that has some opaque geometry will return true. A composite prop (like vtkAssembly) that has at least one sub-prop that has some opaque polygonal geometry will return true. Default implementation return true.

Reimplemented in vtkPolarAxesActor2D, vtkRadialGridActor2D, vtkActor, and vtkWebGPUActor.

Definition at line 312 of file vtkProp.h.

◆ ReleaseGraphicsResources()

virtual void vtkProp::ReleaseGraphicsResources ( vtkWindow * )

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

Definition at line 320 of file vtkProp.h.

◆ GetEstimatedRenderTime() [1/2]

virtual double vtkProp::GetEstimatedRenderTime ( vtkViewport * )

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.

The value is returned in seconds. For simple geometry the accuracy may not be great due to buffering. For ray casting, which is already multi-resolution, the current resolution of the image is factored into the time. We need the viewport for viewing parameters that affect timing. The no-arguments version simply returns the value of the variable with no estimation.

Definition at line 334 of file vtkProp.h.

◆ GetEstimatedRenderTime() [2/2]

virtual double vtkProp::GetEstimatedRenderTime ( )

inlinevirtual

Definition at line 335 of file vtkProp.h.

◆ SetEstimatedRenderTime()

virtual void vtkProp::SetEstimatedRenderTime ( double t )

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.

Definition at line 344 of file vtkProp.h.

◆ RestoreEstimatedRenderTime()

virtual void vtkProp::RestoreEstimatedRenderTime ( )

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.

This method is used to restore that old value should the render be aborted.

Reimplemented in vtkLODProp3D.

Definition at line 358 of file vtkProp.h.

◆ AddEstimatedRenderTime()

virtual void vtkProp::AddEstimatedRenderTime	(	double	t,
		vtkViewport *	vtkNotUsedvp
	)

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.

For example, props that are rendered with a ray casting method do not know themselves how long it took for them to render. We don't want to cause a this->Modified() when we set this value since it is not really a modification to the object. (For example, we don't want to rebuild matrices at every render because the estimated render time is changing)

Definition at line 376 of file vtkProp.h.

◆ SetAllocatedRenderTime()

virtual void vtkProp::SetAllocatedRenderTime	(	double	t,
		vtkViewport *	vtkNotUsedv
	)

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.

Therefore it might need the information provided in the viewport. A side effect of this method is to reset the EstimatedRenderTime to 0.0. This way, each of the ways that this prop may be rendered can be timed and added together into this value.

Definition at line 392 of file vtkProp.h.

◆ GetAllocatedRenderTime()

virtual double vtkProp::GetAllocatedRenderTime ( )

virtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

◆ SetRenderTimeMultiplier()

void vtkProp::SetRenderTimeMultiplier ( double t )

inline

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.

This is used for culling and is a number between 0 and 1. It is used to create the allocated render time value.

Definition at line 415 of file vtkProp.h.

◆ GetRenderTimeMultiplier()

virtual double vtkProp::GetRenderTimeMultiplier ( )

virtual

◆ BuildPaths()

virtual void vtkProp::BuildPaths	(	vtkAssemblyPaths *	paths,
		vtkAssemblyPath *	path
	)

virtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.

Reimplemented in vtkAssembly, vtkPropAssembly, and vtkImageStack.

◆ GetSupportsSelection()

virtual bool vtkProp::GetSupportsSelection ( )

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.

Reimplemented in vtkActor, and vtkVolume.

Definition at line 431 of file vtkProp.h.

◆ ProcessSelectorPixelBuffers()

virtual void vtkProp::ProcessSelectorPixelBuffers	(	vtkHardwareSelector *	,
		std::vector< unsigned int > &
	)

inlinevirtual

allows a prop to update a selections color buffers

Reimplemented in vtkActor.

Definition at line 437 of file vtkProp.h.

◆ GetNumberOfConsumers()

virtual int vtkProp::GetNumberOfConsumers ( )

virtual

Get the number of consumers.

◆ AddConsumer()

void vtkProp::AddConsumer ( vtkObject * c )

Add or remove or get or check a consumer,.

◆ RemoveConsumer()

void vtkProp::RemoveConsumer ( vtkObject * c )

Add or remove or get or check a consumer,.

◆ GetConsumer()

vtkObject * vtkProp::GetConsumer ( int i )

Add or remove or get or check a consumer,.

◆ IsConsumer()

int vtkProp::IsConsumer ( vtkObject * c )

Add or remove or get or check a consumer,.

◆ SetShaderProperty()

virtual void vtkProp::SetShaderProperty ( vtkShaderProperty * property )

virtual

Set/Get the shader property.

◆ GetShaderProperty()

virtual vtkShaderProperty * vtkProp::GetShaderProperty ( )

virtual

Set/Get the shader property.

◆ IsRenderingTranslucentPolygonalGeometry()

virtual bool vtkProp::IsRenderingTranslucentPolygonalGeometry ( )

inlinevirtual

Reimplemented in vtkActor.

Definition at line 469 of file vtkProp.h.

Member Data Documentation

◆ Visibility

vtkTypeBool vtkProp::Visibility

protected

Definition at line 476 of file vtkProp.h.

◆ Pickable

vtkTypeBool vtkProp::Pickable

protected

Definition at line 477 of file vtkProp.h.

◆ Dragable

vtkTypeBool vtkProp::Dragable

protected

Definition at line 478 of file vtkProp.h.

◆ UseBounds

bool vtkProp::UseBounds

protected

Definition at line 479 of file vtkProp.h.

◆ AllocatedRenderTime

double vtkProp::AllocatedRenderTime

protected

Definition at line 481 of file vtkProp.h.

◆ EstimatedRenderTime

double vtkProp::EstimatedRenderTime

protected

Definition at line 482 of file vtkProp.h.

◆ SavedEstimatedRenderTime

double vtkProp::SavedEstimatedRenderTime

protected

Definition at line 483 of file vtkProp.h.

◆ RenderTimeMultiplier

double vtkProp::RenderTimeMultiplier

protected

Definition at line 484 of file vtkProp.h.

◆ NumberOfConsumers

int vtkProp::NumberOfConsumers

protected

Definition at line 487 of file vtkProp.h.

◆ Consumers

vtkObject** vtkProp::Consumers

protected

Definition at line 488 of file vtkProp.h.

◆ Paths

vtkAssemblyPaths* vtkProp::Paths

protected

Definition at line 492 of file vtkProp.h.

◆ PropertyKeys

vtkInformation* vtkProp::PropertyKeys

protected

Definition at line 494 of file vtkProp.h.

◆ ShaderProperty

vtkShaderProperty* vtkProp::ShaderProperty

protected

Definition at line 497 of file vtkProp.h.

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

Rendering/Core/vtkProp.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

◆ vtkProp()

◆ ~vtkProp()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetActors()

◆ GetActors2D()

◆ GetVolumes()

◆ SetVisibility()

◆ GetVisibility()

◆ VisibilityOn()

◆ VisibilityOff()

◆ SetPickable()

◆ GetPickable()

◆ PickableOn()

◆ PickableOff()

◆ Pick()

◆ SetDragable()

◆ GetDragable()

◆ DragableOn()

◆ DragableOff()

◆ GetRedrawMTime()

◆ SetUseBounds()

◆ GetUseBounds()

◆ UseBoundsOn()

◆ UseBoundsOff()

◆ GetBounds()

◆ ShallowCopy()

◆ InitPathTraversal()

◆ GetNextPath()

◆ GetNumberOfPaths()

◆ PokeMatrix()

◆ GetMatrix()

◆ GetPropertyKeys()

◆ SetPropertyKeys()

◆ HasKeys()

◆ GeneralTextureUnit()

◆ GeneralTextureTransform()

◆ RenderOpaqueGeometry()

◆ RenderTranslucentPolygonalGeometry()

◆ RenderVolumetricGeometry()

◆ RenderOverlay()

◆ RenderFilteredOpaqueGeometry()

◆ RenderFilteredTranslucentPolygonalGeometry()

◆ RenderFilteredVolumetricGeometry()

◆ RenderFilteredOverlay()

◆ HasTranslucentPolygonalGeometry()

◆ HasOpaqueGeometry()

◆ ReleaseGraphicsResources()

◆ GetEstimatedRenderTime() [1/2]

◆ GetEstimatedRenderTime() [2/2]

◆ SetEstimatedRenderTime()

◆ RestoreEstimatedRenderTime()

◆ AddEstimatedRenderTime()

◆ SetAllocatedRenderTime()

◆ GetAllocatedRenderTime()

◆ SetRenderTimeMultiplier()

◆ GetRenderTimeMultiplier()

◆ BuildPaths()

◆ GetSupportsSelection()

◆ ProcessSelectorPixelBuffers()

◆ GetNumberOfConsumers()

◆ AddConsumer()

◆ RemoveConsumer()

◆ GetConsumer()

◆ IsConsumer()