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 Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Pick ()
 
virtual unsigned long GetRedrawMTime ()
 
virtual double * GetBounds ()
 
virtual void ShallowCopy (vtkProp *prop)
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 
virtual int HasTranslucentPolygonalGeometry ()
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 
virtual void GetActors (vtkPropCollection *)
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void SetVisibility (int)
 
virtual int GetVisibility ()
 
virtual void VisibilityOn ()
 
virtual void VisibilityOff ()
 
virtual void SetPickable (int)
 
virtual int GetPickable ()
 
virtual void PickableOn ()
 
virtual void PickableOff ()
 
virtual void SetDragable (int)
 
virtual int GetDragable ()
 
virtual void DragableOn ()
 
virtual void DragableOff ()
 
virtual void SetUseBounds (bool)
 
virtual bool GetUseBounds ()
 
virtual void UseBoundsOn ()
 
virtual void UseBoundsOff ()
 
virtual void InitPathTraversal ()
 
virtual vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual vtkInformationGetPropertyKeys ()
 
virtual void SetPropertyKeys (vtkInformation *keys)
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual int RenderOverlay (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 
virtual void RestoreEstimatedRenderTime ()
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 
virtual double GetAllocatedRenderTime ()
 
void SetRenderTimeMultiplier (double t)
 
virtual double GetRenderTimeMultiplier ()
 
virtual bool GetSupportsSelection ()
 
virtual int GetNumberOfConsumers ()
 
void AddConsumer (vtkObject *c)
 
void RemoveConsumer (vtkObject *c)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkProp ()
 
 ~vtkProp ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
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
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int 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
Events:
vtkCommand::PickEvent
Examples:
vtkProp (Examples)
Tests:
vtkProp (Tests)

Definition at line 49 of file vtkProp.h.

Member Typedef Documentation

Definition at line 52 of file vtkProp.h.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual const char* vtkProp::GetClassName ( )
virtual

Reimplemented from vtkObject.

Reimplemented in vtkPropAssembly, vtkActor2D, and vtkContextActor.

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

Reimplemented in vtkPropAssembly, vtkActor2D, and vtkContextActor.

static vtkProp* vtkProp::SafeDownCast ( vtkObject o)
static
void vtkProp::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkPropAssembly, and vtkActor2D.

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

virtual void vtkProp::GetActors2D ( 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.

Reimplemented in vtkActor2D.

Definition at line 60 of file vtkProp.h.

virtual void vtkProp::GetVolumes ( 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 61 of file vtkProp.h.

virtual void vtkProp::SetVisibility ( int  )
virtual

Set/Get visibility of this vtkProp. Initial value is true.

virtual int vtkProp::GetVisibility ( )
virtual

Set/Get visibility of this vtkProp. Initial value is true.

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 unsigned long 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.

Definition at line 99 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 ( )
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 vtkPropAssembly.

Definition at line 113 of file vtkProp.h.

virtual void vtkProp::ShallowCopy ( vtkProp prop)
virtual

Shallow copy of this vtkProp.

Reimplemented in vtkActor2D, and vtkPropAssembly.

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

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

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

Definition at line 132 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 139 of file vtkProp.h.

virtual vtkMatrix4x4* vtkProp::GetMatrix ( )
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 140 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
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 thrid 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 vtkPropAssembly, and vtkActor2D.

Definition at line 171 of file vtkProp.h.

virtual int vtkProp::RenderTranslucentPolygonalGeometry ( 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 thrid 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 vtkPropAssembly, and vtkActor2D.

Definition at line 172 of file vtkProp.h.

virtual int vtkProp::RenderVolumetricGeometry ( 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 thrid 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 vtkPropAssembly.

Definition at line 173 of file vtkProp.h.

virtual int vtkProp::RenderOverlay ( 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 thrid 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 vtkPropAssembly, vtkActor2D, and vtkContextActor.

Definition at line 174 of file vtkProp.h.

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

Definition at line 230 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 vtkActor2D, vtkPropAssembly, and vtkContextActor.

Definition at line 236 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 249 of file vtkProp.h.

virtual double vtkProp::GetEstimatedRenderTime ( )
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 251 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 259 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.

Definition at line 269 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 285 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 297 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 316 of file vtkProp.h.

virtual double vtkProp::GetRenderTimeMultiplier ( )
virtual

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.

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

Definition at line 330 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 353 of file vtkProp.h.

int vtkProp::Pickable
protected

Definition at line 354 of file vtkProp.h.

int vtkProp::Dragable
protected

Definition at line 355 of file vtkProp.h.

bool vtkProp::UseBounds
protected

Definition at line 356 of file vtkProp.h.

double vtkProp::AllocatedRenderTime
protected

Definition at line 358 of file vtkProp.h.

double vtkProp::EstimatedRenderTime
protected

Definition at line 359 of file vtkProp.h.

double vtkProp::SavedEstimatedRenderTime
protected

Definition at line 360 of file vtkProp.h.

double vtkProp::RenderTimeMultiplier
protected

Definition at line 361 of file vtkProp.h.

int vtkProp::NumberOfConsumers
protected

Definition at line 364 of file vtkProp.h.

vtkObject** vtkProp::Consumers
protected

Definition at line 365 of file vtkProp.h.

vtkAssemblyPaths* vtkProp::Paths
protected

Definition at line 369 of file vtkProp.h.

vtkInformation* vtkProp::PropertyKeys
protected

Definition at line 371 of file vtkProp.h.


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