VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkProp Class Reference

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

#include <vtkProp.h>

Inheritance diagram for vtkProp:
[legend]
Collaboration diagram for vtkProp:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void GetActors (vtkPropCollection *)
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
virtual doubleGetBounds ()
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
virtual void ShallowCopy (vtkProp *prop)
 Shallow copy of this vtkProp. More...
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
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. More...
 
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. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
virtual int 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. More...
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void SetVisibility (int)
 Set/Get visibility of this vtkProp. More...
 
virtual int GetVisibility ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp. More...
 
virtual void SetPickable (int)
 Set/Get the pickable instance variable. More...
 
virtual int GetPickable ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOn ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOff ()
 Set/Get the pickable instance variable. More...
 
virtual void SetDragable (int)
 Set/Get the value of the dragable instance variable. More...
 
virtual int GetDragable ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable. More...
 
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(). More...
 
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(). More...
 
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(). More...
 
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(). More...
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys. More...
 
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. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,. More...
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int Visibility
 
int Pickable
 
int Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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
Examples:
vtkProp (Examples)
Tests:
vtkProp (Tests)

Definition at line 50 of file vtkProp.h.

Member Typedef Documentation

Definition at line 53 of file vtkProp.h.

Constructor & Destructor Documentation

vtkProp::vtkProp ( )
protected
vtkProp::~vtkProp ( )
overrideprotected

Member Function Documentation

static int vtkProp::IsTypeOf ( const char *  type)
static
virtual int 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.

Reimplemented in vtkXYPlotActor, vtkContourRepresentation, vtkBalloonRepresentation, vtkSphereRepresentation, vtkParallelCoordinatesActor, vtkScalarBarActor, vtkSpiderPlotActor, vtkImplicitCylinderRepresentation, vtkCaptionActor2D, vtkAssembly, vtkImplicitPlaneRepresentation, vtkTexturedButtonRepresentation, vtkLODActor, vtkAffineRepresentation2D, vtkAxisActor, vtkQuadricLODActor, vtkAxesActor, vtkAxisActor2D, vtkBoxRepresentation, vtkTexturedButtonRepresentation2D, vtkBiDimensionalRepresentation2D, vtkCenteredSliderRepresentation, vtkLineRepresentation, vtkCubeAxesActor, vtkSliderRepresentation2D, vtkLODProp3D, vtkBorderRepresentation, vtkConstrainedPointHandleRepresentation, vtkRectilinearWipeRepresentation, vtkCompassRepresentation, vtkCubeAxesActor2D, vtkLegendScaleActor, vtkSliderRepresentation3D, vtkWidgetRepresentation, vtkAnnotatedCubeActor, vtkParallelopipedRepresentation, vtkProp3DButtonRepresentation, vtkAxesTransformRepresentation, vtkCameraRepresentation, vtkFinitePlaneRepresentation, vtkHandleRepresentation, vtkDistanceRepresentation3D, vtkLegendBoxActor, vtkCaptionRepresentation, vtkResliceCursorLineRepresentation, vtkPolarAxesActor, vtkAngleRepresentation3D, vtkLeaderActor2D, vtkPieChartActor, vtkAbstractPolygonalHandleRepresentation3D, vtkPointHandleRepresentation2D, vtkResliceCursorRepresentation, vtkLogoRepresentation, vtkBarChartActor, vtkAngleRepresentation2D, vtkBiDimensionalRepresentation, vtkDistanceRepresentation2D, vtkMeasurementCubeHandleRepresentation3D, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkProp3DFollower, vtkPropAssembly, vtkTextActor, vtkOpenVRControlsHelper, vtkCheckerboardRepresentation, vtkFixedSizeHandleRepresentation3D, vtkLightActor, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkOrientedGlyphContourRepresentation, vtkSphereHandleRepresentation, vtkPointHandleRepresentation3D, vtkImageSlice, vtkOpenVRMenuRepresentation, vtkAffineRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkSplineRepresentation, vtkActor, vtkResliceCursorThickLineRepresentation, vtkSeedRepresentation, vtkTextRepresentation, vtkCornerAnnotation, vtkVolume, vtkButtonRepresentation, vtkCurveRepresentation, vtkProgressBarRepresentation, vtkProp3DAxisFollower, vtkImageActor, vtkPolygonalHandleRepresentation3D, vtkTextActor3D, vtkResliceCursorActor, vtkTensorProbeRepresentation, vtkOpenVRPanelRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkSliderRepresentation, vtkActor2D, vtkFollower, vtkProp3D, vtkImageStack, vtkFocalPlaneContourRepresentation, vtkAngleRepresentation, vtkPolyLineRepresentation, vtkTexturedActor2D, vtkContinuousValueWidgetRepresentation, vtkXYPlotRepresentation, vtkAxisFollower, vtkContextActor, vtkDistanceRepresentation, vtkCameraActor, vtkOpenGLSkybox, vtkBillboardTextActor3D, vtkScaledTextActor, vtkOpenGLActor, vtkOpenGLActor, vtkOpenGLContextActor, vtkOpenGLContextActor, vtkOpenGLBillboardTextActor3D, vtkOpenGLTextActor, vtkOpenGLTextActor3D, vtkSkybox, and vtkOpenVRFollower.

static vtkProp* vtkProp::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkProp::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkXYPlotActor, vtkContourRepresentation, vtkBalloonRepresentation, vtkSphereRepresentation, vtkParallelCoordinatesActor, vtkScalarBarActor, vtkSpiderPlotActor, vtkImplicitCylinderRepresentation, vtkCaptionActor2D, vtkAssembly, vtkImplicitPlaneRepresentation, vtkTexturedButtonRepresentation, vtkLODActor, vtkAffineRepresentation2D, vtkAxisActor, vtkQuadricLODActor, vtkAxesActor, vtkAxisActor2D, vtkBoxRepresentation, vtkTexturedButtonRepresentation2D, vtkBiDimensionalRepresentation2D, vtkCenteredSliderRepresentation, vtkLineRepresentation, vtkCubeAxesActor, vtkSliderRepresentation2D, vtkLODProp3D, vtkBorderRepresentation, vtkConstrainedPointHandleRepresentation, vtkRectilinearWipeRepresentation, vtkCompassRepresentation, vtkCubeAxesActor2D, vtkLegendScaleActor, vtkSliderRepresentation3D, vtkWidgetRepresentation, vtkAnnotatedCubeActor, vtkParallelopipedRepresentation, vtkProp3DButtonRepresentation, vtkAxesTransformRepresentation, vtkCameraRepresentation, vtkFinitePlaneRepresentation, vtkHandleRepresentation, vtkDistanceRepresentation3D, vtkLegendBoxActor, vtkCaptionRepresentation, vtkResliceCursorLineRepresentation, vtkPolarAxesActor, vtkAngleRepresentation3D, vtkLeaderActor2D, vtkPieChartActor, vtkAbstractPolygonalHandleRepresentation3D, vtkPointHandleRepresentation2D, vtkResliceCursorRepresentation, vtkLogoRepresentation, vtkBarChartActor, vtkAngleRepresentation2D, vtkBiDimensionalRepresentation, vtkDistanceRepresentation2D, vtkMeasurementCubeHandleRepresentation3D, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkProp3DFollower, vtkPropAssembly, vtkTextActor, vtkOpenVRControlsHelper, vtkCheckerboardRepresentation, vtkFixedSizeHandleRepresentation3D, vtkLightActor, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkOrientedGlyphContourRepresentation, vtkSphereHandleRepresentation, vtkPointHandleRepresentation3D, vtkImageSlice, vtkOpenVRMenuRepresentation, vtkAffineRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkSplineRepresentation, vtkActor, vtkResliceCursorThickLineRepresentation, vtkSeedRepresentation, vtkTextRepresentation, vtkCornerAnnotation, vtkVolume, vtkButtonRepresentation, vtkCurveRepresentation, vtkProgressBarRepresentation, vtkProp3DAxisFollower, vtkImageActor, vtkPolygonalHandleRepresentation3D, vtkTextActor3D, vtkResliceCursorActor, vtkTensorProbeRepresentation, vtkOpenVRPanelRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkSliderRepresentation, vtkActor2D, vtkFollower, vtkProp3D, vtkImageStack, vtkFocalPlaneContourRepresentation, vtkAngleRepresentation, vtkPolyLineRepresentation, vtkTexturedActor2D, vtkContinuousValueWidgetRepresentation, vtkXYPlotRepresentation, vtkAxisFollower, vtkContextActor, vtkDistanceRepresentation, vtkCameraActor, vtkOpenGLSkybox, vtkBillboardTextActor3D, vtkScaledTextActor, vtkOpenGLActor, vtkOpenGLActor, vtkOpenGLContextActor, vtkOpenGLContextActor, vtkOpenGLBillboardTextActor3D, vtkOpenGLTextActor, vtkOpenGLTextActor3D, vtkSkybox, and vtkOpenVRFollower.

vtkProp* vtkProp::NewInstance ( ) const
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 vtkLODActor, vtkQuadricLODActor, vtkProp3DFollower, vtkPropAssembly, vtkTextActor, vtkOpenVRControlsHelper, vtkOpenVRMenuRepresentation, vtkVolume, vtkTextActor3D, vtkOpenVRPanelRepresentation, vtkProp3D, vtkImageStack, vtkTexturedActor2D, vtkOpenGLSkybox, vtkScaledTextActor, vtkOpenGLActor, vtkOpenGLActor, vtkOpenGLBillboardTextActor3D, vtkOpenGLTextActor, vtkOpenGLTextActor3D, vtkSkybox, and vtkOpenVRFollower.

virtual void vtkProp::GetActors ( vtkPropCollection )
inlinevirtual
virtual void vtkProp::GetActors2D ( vtkPropCollection )
inlinevirtual
virtual void vtkProp::GetVolumes ( vtkPropCollection )
inlinevirtual

Reimplemented in vtkLODProp3D, vtkWidgetRepresentation, vtkAssembly, and vtkVolume.

Definition at line 63 of file vtkProp.h.

virtual void vtkProp::SetVisibility ( int  )
virtual

Set/Get visibility of this vtkProp.

Initial value is true.

Reimplemented in vtkScalarBarRepresentation, and vtkXYPlotRepresentation.

virtual int vtkProp::GetVisibility ( )
virtual

Set/Get visibility of this vtkProp.

Initial value is true.

Reimplemented in vtkScalarBarRepresentation, and vtkXYPlotRepresentation.

virtual void vtkProp::VisibilityOn ( )
virtual

Set/Get visibility of this vtkProp.

Initial value is true.

virtual void vtkProp::VisibilityOff ( )
virtual

Set/Get visibility of this vtkProp.

Initial value is true.

virtual void vtkProp::SetPickable ( int  )
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.

virtual int 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.

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.

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.

virtual void vtkProp::Pick ( )
virtual

Method fires PickEvent if the prop is picked.

virtual void vtkProp::SetDragable ( int  )
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.

virtual int 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.

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.

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.

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 vtkActor, vtkAxesActor, vtkImageStack, vtkVolume, and vtkImageSlice.

Definition at line 111 of file vtkProp.h.

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.

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.

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.

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.

virtual double* vtkProp::GetBounds ( void  )
inlinevirtual
virtual void vtkProp::ShallowCopy ( vtkProp prop)
virtual
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 vtkProp3D, vtkImageStack, vtkAssembly, vtkPropAssembly, and vtkProp3DFollower.

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 vtkImageStack, vtkAssembly, vtkPropAssembly, and vtkProp3DFollower.

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 vtkImageStack, vtkAssembly, and vtkPropAssembly.

Definition at line 153 of file vtkProp.h.

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 162 of file vtkProp.h.

virtual vtkMatrix4x4* vtkProp::GetMatrix ( )
inlinevirtual

Reimplemented in vtkProp3D.

Definition at line 163 of file vtkProp.h.

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.

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.

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
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 comunication of when a texture is being used. This key can be used to pass that information down to a mapper.

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 comunication of when a texture is being used. This key can be used to pass that information down to a mapper.

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 vtkXYPlotActor, vtkAxisActor, vtkContourRepresentation, vtkImplicitPlaneRepresentation, vtkAxisActor2D, vtkImplicitCylinderRepresentation, vtkSphereRepresentation, vtkLODProp3D, vtkTextActor, vtkBorderRepresentation, vtkSpiderPlotActor, vtkCaptionActor2D, vtkLegendBoxActor, vtkConstrainedPointHandleRepresentation, vtkQuadricLODActor, vtkCurveRepresentation, vtkPointHandleRepresentation3D, vtkLegendScaleActor, vtkBoxRepresentation, vtkLeaderActor2D, vtkLineRepresentation, vtkBarChartActor, vtkParallelopipedRepresentation, vtkPieChartActor, vtkSliderRepresentation3D, vtkTexturedButtonRepresentation, vtkSliderRepresentation2D, vtkProp3DAxisFollower, vtkParallelCoordinatesActor, vtkDistanceRepresentation3D, vtkAxesTransformRepresentation, vtkCenteredSliderRepresentation, vtkFinitePlaneRepresentation, vtkImageSlice, vtkImageStack, vtkCompassRepresentation, vtkRectilinearWipeRepresentation, vtkSphereHandleRepresentation, vtkAxisFollower, vtkCameraRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkTextActor3D, vtkCheckerboardRepresentation, vtkOrientedGlyphContourRepresentation, vtkAngleRepresentation3D, vtkAssembly, vtkProgressBarRepresentation, vtkProp3DButtonRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkOpenVRPanelRepresentation, vtkMeasurementCubeHandleRepresentation3D, vtkCaptionRepresentation, vtkDistanceRepresentation2D, vtkLODActor, vtkScalarBarActor, vtkPlaybackRepresentation, vtkBillboardTextActor3D, vtkScalarBarRepresentation, vtkTextRepresentation, vtkAxesActor, vtkPropAssembly, vtkCubeAxesActor, vtkProp3DFollower, vtkOpenVRControlsHelper, vtkResliceCursorLineRepresentation, vtkCubeAxesActor2D, vtkLightActor, vtkAnnotatedCubeActor, vtkXYPlotRepresentation, vtkPolarAxesActor, vtkActor, vtkFollower, vtkTexturedActor2D, vtkCornerAnnotation, vtkCameraActor, vtkResliceCursorActor, vtkActor2D, vtkTensorProbeRepresentation, and vtkEllipsoidTensorProbeRepresentation.

Definition at line 222 of file vtkProp.h.

virtual int vtkProp::RenderTranslucentPolygonalGeometry ( vtkViewport )
inlinevirtual

Reimplemented in vtkXYPlotActor, vtkAxisActor, vtkContourRepresentation, vtkImplicitPlaneRepresentation, vtkAxisActor2D, vtkImplicitCylinderRepresentation, vtkSphereRepresentation, vtkLODProp3D, vtkTextActor, vtkBorderRepresentation, vtkSpiderPlotActor, vtkCaptionActor2D, vtkLegendBoxActor, vtkConstrainedPointHandleRepresentation, vtkCurveRepresentation, vtkPointHandleRepresentation3D, vtkBoxRepresentation, vtkLeaderActor2D, vtkLineRepresentation, vtkBarChartActor, vtkPieChartActor, vtkSliderRepresentation3D, vtkTexturedButtonRepresentation, vtkParallelCoordinatesActor, vtkProp3DAxisFollower, vtkDistanceRepresentation3D, vtkAxesTransformRepresentation, vtkFinitePlaneRepresentation, vtkImageSlice, vtkImageStack, vtkRectilinearWipeRepresentation, vtkSphereHandleRepresentation, vtkAxisFollower, vtkCameraRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkTextActor3D, vtkCheckerboardRepresentation, vtkOrientedGlyphContourRepresentation, vtkAngleRepresentation3D, vtkAssembly, vtkProgressBarRepresentation, vtkProp3DButtonRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkOpenVRPanelRepresentation, vtkMeasurementCubeHandleRepresentation3D, vtkCaptionRepresentation, vtkScalarBarActor, vtkBillboardTextActor3D, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, vtkAxesActor, vtkPropAssembly, vtkCubeAxesActor, vtkProp3DFollower, vtkOpenVRControlsHelper, vtkResliceCursorLineRepresentation, vtkCubeAxesActor2D, vtkAnnotatedCubeActor, vtkPolarAxesActor, vtkXYPlotRepresentation, vtkActor, vtkFollower, vtkTexturedActor2D, vtkCornerAnnotation, vtkActor2D, vtkOpenGLBillboardTextActor3D, and vtkOpenGLTextActor3D.

Definition at line 224 of file vtkProp.h.

virtual int vtkProp::RenderVolumetricGeometry ( vtkViewport )
inlinevirtual
virtual int vtkProp::RenderOverlay ( vtkViewport )
inlinevirtual
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
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
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
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
virtual int 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 vtkXYPlotActor, vtkAxisActor, vtkContourRepresentation, vtkImplicitPlaneRepresentation, vtkAxisActor2D, vtkImplicitCylinderRepresentation, vtkSphereRepresentation, vtkLODProp3D, vtkTextActor, vtkBorderRepresentation, vtkSpiderPlotActor, vtkCaptionActor2D, vtkLegendBoxActor, vtkWidgetRepresentation, vtkConstrainedPointHandleRepresentation, vtkCurveRepresentation, vtkPointHandleRepresentation3D, vtkBoxRepresentation, vtkLeaderActor2D, vtkLineRepresentation, vtkBarChartActor, vtkPieChartActor, vtkSliderRepresentation3D, vtkTexturedButtonRepresentation, vtkParallelCoordinatesActor, vtkImageActor, vtkTexturedButtonRepresentation2D, vtkImageSlice, vtkFinitePlaneRepresentation, vtkImageStack, vtkRectilinearWipeRepresentation, vtkSphereHandleRepresentation, vtkCameraRepresentation, vtkTextActor3D, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkCheckerboardRepresentation, vtkAssembly, vtkOrientedGlyphContourRepresentation, vtkAngleRepresentation3D, vtkProgressBarRepresentation, vtkProp3DButtonRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkOpenVRPanelRepresentation, vtkMeasurementCubeHandleRepresentation3D, vtkCaptionRepresentation, vtkScalarBarActor, vtkAxesActor, vtkPropAssembly, vtkPlaybackRepresentation, vtkProp3DFollower, vtkScalarBarRepresentation, vtkTextRepresentation, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkAnnotatedCubeActor, vtkLightActor, vtkOpenVRControlsHelper, vtkResliceCursorLineRepresentation, vtkBillboardTextActor3D, vtkOpenVRMenuRepresentation, vtkActor, vtkFollower, vtkXYPlotRepresentation, vtkCornerAnnotation, vtkActor2D, vtkCameraActor, and vtkResliceCursorActor.

Definition at line 294 of file vtkProp.h.

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.

Reimplemented in vtkXYPlotActor, vtkAxisActor, vtkContourRepresentation, vtkImplicitPlaneRepresentation, vtkAxisActor2D, vtkImplicitCylinderRepresentation, vtkCubeAxesActor2D, vtkLODProp3D, vtkSphereRepresentation, vtkCubeAxesActor, vtkTextActor, vtkPolarAxesActor, vtkSpiderPlotActor, vtkBorderRepresentation, vtkQuadricLODActor, vtkConstrainedPointHandleRepresentation, vtkWidgetRepresentation, vtkCurveRepresentation, vtkCaptionActor2D, vtkLegendBoxActor, vtkPointHandleRepresentation3D, vtkLeaderActor2D, vtkLegendScaleActor, vtkBoxRepresentation, vtkBalloonRepresentation, vtkLineRepresentation, vtkBarChartActor, vtkPieChartActor, vtkParallelCoordinatesActor, vtkParallelopipedRepresentation, vtkSliderRepresentation3D, vtkAffineRepresentation2D, vtkTexturedButtonRepresentation, vtkImageSlice, vtkActor2D, vtkTexturedButtonRepresentation2D, vtkSliderRepresentation2D, vtkDistanceRepresentation3D, vtkImageStack, vtkAxesTransformRepresentation, vtkCenteredSliderRepresentation, vtkFinitePlaneRepresentation, vtkVolume, vtkCompassRepresentation, vtkRectilinearWipeRepresentation, vtkSphereHandleRepresentation, vtkAssembly, vtkCameraRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkCheckerboardRepresentation, vtkAngleRepresentation3D, vtkOrientedGlyphContourRepresentation, vtkCornerAnnotation, vtkBiDimensionalRepresentation2D, vtkProgressBarRepresentation, vtkProp3DButtonRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkOpenVRPanelRepresentation, vtkPointHandleRepresentation2D, vtkScalarBarActor, vtkMeasurementCubeHandleRepresentation3D, vtkAxesActor, vtkCaptionRepresentation, vtkDistanceRepresentation2D, vtkAngleRepresentation2D, vtkLODActor, vtkPropAssembly, vtkTextActor3D, vtkActor, vtkTensorProbeRepresentation, vtkAnnotatedCubeActor, vtkProp3DFollower, vtkBillboardTextActor3D, vtkLightActor, vtkPlaybackRepresentation, vtkLogoRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, vtkFollower, vtkOpenVRControlsHelper, vtkContextActor, vtkOpenVRMenuRepresentation, vtkResliceCursorLineRepresentation, vtkCameraActor, vtkResliceCursorActor, vtkXYPlotRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkTexturedActor2D, vtkOpenGLContextActor, and vtkOpenGLContextActor.

Definition at line 303 of file vtkProp.h.

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 317 of file vtkProp.h.

virtual double vtkProp::GetEstimatedRenderTime ( )
inlinevirtual

Definition at line 319 of file vtkProp.h.

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 329 of file vtkProp.h.

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 340 of file vtkProp.h.

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 357 of file vtkProp.h.

virtual void vtkProp::SetAllocatedRenderTime ( double  t,
vtkViewport vtkNotUsed
)
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 371 of file vtkProp.h.

virtual double vtkProp::GetAllocatedRenderTime ( )
virtual

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

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 394 of file vtkProp.h.

virtual double vtkProp::GetRenderTimeMultiplier ( )
virtual
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, vtkImageStack, and vtkPropAssembly.

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 vtkVolume, and vtkActor.

Definition at line 411 of file vtkProp.h.

virtual int vtkProp::GetNumberOfConsumers ( )
virtual

Get the number of consumers.

void vtkProp::AddConsumer ( vtkObject c)

Add or remove or get or check a consumer,.

void vtkProp::RemoveConsumer ( vtkObject c)

Add or remove or get or check a consumer,.

vtkObject* vtkProp::GetConsumer ( int  i)

Add or remove or get or check a consumer,.

int vtkProp::IsConsumer ( vtkObject c)

Add or remove or get or check a consumer,.

Member Data Documentation

int vtkProp::Visibility
protected

Definition at line 435 of file vtkProp.h.

int vtkProp::Pickable
protected

Definition at line 436 of file vtkProp.h.

int vtkProp::Dragable
protected

Definition at line 437 of file vtkProp.h.

bool vtkProp::UseBounds
protected

Definition at line 438 of file vtkProp.h.

double vtkProp::AllocatedRenderTime
protected

Definition at line 440 of file vtkProp.h.

double vtkProp::EstimatedRenderTime
protected

Definition at line 441 of file vtkProp.h.

double vtkProp::SavedEstimatedRenderTime
protected

Definition at line 442 of file vtkProp.h.

double vtkProp::RenderTimeMultiplier
protected

Definition at line 443 of file vtkProp.h.

int vtkProp::NumberOfConsumers
protected

Definition at line 446 of file vtkProp.h.

vtkObject** vtkProp::Consumers
protected

Definition at line 447 of file vtkProp.h.

vtkAssemblyPaths* vtkProp::Paths
protected

Definition at line 451 of file vtkProp.h.

vtkInformation* vtkProp::PropertyKeys
protected

Definition at line 453 of file vtkProp.h.


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