#include <vtkProp.h>
Inheritance diagram for vtkProp:
Public Methods | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| 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 () |
| void | SetPickMethod (void(*f)(void *), void *arg) |
| void | SetPickMethodArgDelete (void(*f)(void *)) |
| virtual void | Pick () |
| virtual void | SetDragable (int) |
| virtual int | GetDragable () |
| virtual void | DragableOn () |
| virtual void | DragableOff () |
| virtual unsigned long | GetRedrawMTime () |
| virtual float * | GetBounds () |
| virtual void | ShallowCopy (vtkProp *prop) |
| virtual void | InitPathTraversal () |
| virtual vtkAssemblyPath * | GetNextPath () |
| virtual int | GetNumberOfPaths () |
| virtual void | PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix)) |
| virtual vtkMatrix4x4 * | GetMatrix () |
| virtual int | RequiresRayCasting () |
| virtual int | RequiresRenderingIntoImage () |
| virtual int | RenderOpaqueGeometry (vtkViewport *) |
| virtual int | RenderTranslucentGeometry (vtkViewport *) |
| virtual int | InitializeRayCasting (vtkViewport *) |
| virtual int | CastViewRay (VTKRayCastRayInfo *) |
| virtual int | RenderIntoImage (vtkViewport *) |
| virtual float * | GetRGBAImage () |
| virtual float * | GetZImage () |
| virtual int | RenderOverlay (vtkViewport *) |
| virtual void | ReleaseGraphicsResources (vtkWindow *) |
| virtual float | GetEstimatedRenderTime (vtkViewport *) |
| virtual float | GetEstimatedRenderTime () |
| virtual void | SetEstimatedRenderTime (float t) |
| virtual void | RestoreEstimatedRenderTime () |
| virtual void | AddEstimatedRenderTime (float t, vtkViewport *vtkNotUsed(vp)) |
| virtual void | SetAllocatedRenderTime (float t, vtkViewport *vtkNotUsed(v)) |
| virtual float | GetAllocatedRenderTime () |
| void | SetRenderTimeMultiplier (float t) |
| virtual float | GetRenderTimeMultiplier () |
| virtual void | BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path) |
| virtual vtkMatrix4x4 * | GetMatrixPointer () |
Static Public Methods | |
| vtkProp * | New () |
| int | IsTypeOf (const char *type) |
| vtkProp * | SafeDownCast (vtkObject *o) |
Protected Methods | |
| vtkProp () | |
| ~vtkProp () | |
| vtkProp (const vtkProp &) | |
| void | operator= (const vtkProp &) |
Protected Attributes | |
| int | Visibility |
| int | Pickable |
| unsigned long | PickTag |
| int | Dragable |
| float | AllocatedRenderTime |
| float | EstimatedRenderTime |
| float | SavedEstimatedRenderTime |
| float | RenderTimeMultiplier |
| vtkAssemblyPaths * | Paths |
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.
Definition at line 68 of file vtkProp.h.
|
|
|
|
|
|
|
|
|
|
|
Creates an instance with visibility=1, pickable=1, and dragable=1. Reimplemented from vtkObject. Reimplemented in vtkActor2D, vtkPropAssembly, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkActor, vtkAssembly, vtkFollower, vtkImageActor, vtkLODActor, vtkLODProp3D, vtkMesaActor, vtkMesaImageActor, vtkOpenGLActor, vtkOpenGLImageActor, vtkVolume, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor. |
|
|
Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkActor2D, vtkPropAssembly, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkActor, vtkAssembly, vtkFollower, vtkImageActor, vtkLODActor, vtkLODProp3D, vtkMesaActor, vtkMesaImageActor, vtkOpenGLActor, vtkOpenGLImageActor, vtkProp3D, vtkVolume, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor. |
|
|
Return 1 if this class type 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 vtkActor2D, vtkPropAssembly, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkActor, vtkAssembly, vtkFollower, vtkImageActor, vtkLODActor, vtkLODProp3D, vtkMesaActor, vtkMesaImageActor, vtkOpenGLActor, vtkOpenGLImageActor, vtkProp3D, vtkVolume, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor. |
|
|
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 vtkActor2D, vtkPropAssembly, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkActor, vtkAssembly, vtkFollower, vtkImageActor, vtkLODActor, vtkLODProp3D, vtkMesaActor, vtkMesaImageActor, vtkOpenGLActor, vtkOpenGLImageActor, vtkProp3D, vtkVolume, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor. |
|
|
Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkActor2D, vtkPropAssembly, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkActor, vtkAssembly, vtkFollower, vtkImageActor, vtkLODActor, vtkLODProp3D, vtkMesaActor, vtkMesaImageActor, vtkOpenGLActor, vtkOpenGLImageActor, vtkProp3D, vtkVolume, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor. Referenced by vtkPropCollection::GetLastProp(), and vtkPropCollection::GetNextProp().
|
|
||||||||||||
|
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 vtkActor2D, vtkPropAssembly, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkActor, vtkAssembly, vtkFollower, vtkImageActor, vtkLODActor, vtkLODProp3D, vtkProp3D, vtkVolume, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor. |
|
|
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 vtkActor, vtkAssembly, and vtkLODProp3D. |
|
|
Reimplemented in vtkActor2D. |
|
|
Reimplemented in vtkAssembly, and vtkVolume. |
|
|
Set/Get visibility of this vtkProp. |
|
|
|
|
|
|
|
|
|
|
|
Set/Get the pickable instance variable. This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. |
|
|
|
|
|
|
|
|
|
|
||||||||||||
|
This method is invoked when an instance of vtkProp (or subclass, e.g., vtkActor) is picked by vtkPicker. Reimplemented in vtkLODProp3D. |
|
|
Reimplemented in vtkLODProp3D. |
|
|
Method invokes PickMethod() if one defined and the prop is picked. |
|
|
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. |
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
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, vtkCubeAxesActor2D, vtkActor, vtkAssembly, vtkImageActor, vtkLODProp3D, vtkProp3D, and vtkVolume. |
|
|
Shallow copy of this vtkProp. Reimplemented in vtkActor2D, vtkPropAssembly, vtkLegendBoxActor, vtkActor, vtkAssembly, vtkFollower, vtkLODActor, vtkLODProp3D, vtkProp3D, vtkVolume, vtkAxisActor2D, vtkScalarBarActor, and vtkScaledTextActor. |
|
|
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, vtkAssembly, and vtkProp3D. |
|
|
Reimplemented in vtkPropAssembly, and vtkAssembly. |
|
|
Reimplemented in vtkPropAssembly, and vtkAssembly. |
|
|
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. |
|
|
Reimplemented in vtkFollower, and vtkProp3D. Definition at line 145 of file vtkProp.h. Referenced by vtkProp3D::GetMatrix().
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Do we need to ray cast this prop? For certain types of props (vtkLODProp3D for example) this method is not guaranteed to work outside of the rendering process, since a level of detail must be selected before this question can be answered. Reimplemented in vtkLODProp3D, and vtkVolume. |
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop render into an image? For certain types of props (vtkLODProp3D for example) this method is not guaranteed to work outside of the rendering process, since a level of detail must be selected before this question can be answered. Reimplemented in vtkLODProp3D, and vtkVolume. |
|
|
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 five key render methods in vtk and they correspond to five different points in the rendering cycle. Any given prop may implement one or more of these methods. The first two methods are designed to render 3D geometry such as polygons lines, triangles. We render the opaque first then the transparent. Ray casting is different from the other methods in that the rendering process is driven not by the mapper but by the ray caster. Two methods are required to support ray casting - one for initialization, and the other to cast a ray (in viewing coordinates.) The next three methods are primarily intended for volume rendering and supports any technique that returns an image to be composited. The RenderIntoImage() method causes the rendering to occur, and the GetRGBAImage() and GetZImage() methods are used to gather results. The last method is to render any 2D annotation or overlays. Except for the ray casting methods, these methods return an integer value indicating whether or not this render method was applied to this data. For the ray cast initialization, the integer indicated whether or not the initialization was successful. For ray casting, the integer return value indicates whether or not the ray intersected something. Reimplemented in vtkActor2D, vtkPropAssembly, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkActor, vtkAssembly, vtkFollower, vtkImageActor, vtkLODActor, vtkLODProp3D, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor. |
|
|
|
Reimplemented in vtkPropAssembly, vtkLODProp3D, and vtkVolume. |
|
|
Reimplemented in vtkPropAssembly, vtkLODProp3D, and vtkVolume. |
|
|
Reimplemented in vtkPropAssembly, vtkLODProp3D, and vtkVolume. |
|
|
Reimplemented in vtkVolume. |
|
|
Reimplemented in vtkVolume. |
|
|
Reimplemented in vtkActor2D, vtkPropAssembly, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor. |
|
|
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, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkActor, vtkAssembly, vtkLODActor, vtkLODProp3D, vtkMesaImageActor, vtkOpenGLImageActor, vtkVolume, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor. |
|
|
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. Reimplemented in vtkVolume. |
|
|
Reimplemented in vtkVolume. Definition at line 213 of file vtkProp.h. Referenced by vtkVolume::GetEstimatedRenderTime().
|
|
|
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. |
|
|
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. |
|
||||||||||||
|
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) |
|
||||||||||||
|
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. |
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS |
|
|
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. |
|
|
|
|
||||||||||||
|
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, and vtkAssembly. |
|
|
Reimplemented in vtkProp3D. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.2.11.1 written by Dimitri van Heesch,
© 1997-2001