vtkProp Class Reference
#include <vtkProp.h>
Detailed Description
abstract superclass for all actors, volumes and annotationsvtkProp 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
- Tests:
- vtkProp (Tests)
Definition at line 46 of file vtkProp.h.
Member Typedef Documentation
| typedef vtkObject vtkProp::Superclass |
Reimplemented from vtkObject.
Reimplemented in vtkActor2D, vtkPropAssembly, vtkCompassRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkLegendScaleActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkWidgetRepresentation, vtkActor, vtkAssembly, vtkAxisActor2D, vtkCameraActor, vtkFollower, vtkImageActor, vtkLeaderActor2D, vtkLightActor, vtkLODActor, vtkLODProp3D, vtkMesaActor, vtkMesaImageActor, vtkOpenGLActor, vtkOpenGLImageActor, vtkParallelCoordinatesActor, vtkProp3D, vtkQuadricLODActor, vtkScalarBarActor, vtkScaledTextActor, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, and vtkVolume.
Constructor & Destructor Documentation
| vtkProp::vtkProp | ( | ) | [protected] |
| vtkProp::~vtkProp | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkProp::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkActor2D, vtkPropAssembly, vtkCompassRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkLegendScaleActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkWidgetRepresentation, vtkActor, vtkAssembly, vtkAxisActor2D, vtkCameraActor, vtkFollower, vtkImageActor, vtkLeaderActor2D, vtkLightActor, vtkLODActor, vtkLODProp3D, vtkMesaActor, vtkMesaImageActor, vtkOpenGLActor, vtkOpenGLImageActor, vtkParallelCoordinatesActor, vtkProp3D, vtkQuadricLODActor, vtkScalarBarActor, vtkScaledTextActor, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, and vtkVolume.
| static int vtkProp::IsTypeOf | ( | const char * | name | ) | [static] |
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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkActor2D, vtkPropAssembly, vtkCompassRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkLegendScaleActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkWidgetRepresentation, vtkActor, vtkAssembly, vtkAxisActor2D, vtkCameraActor, vtkFollower, vtkImageActor, vtkLeaderActor2D, vtkLightActor, vtkLODActor, vtkLODProp3D, vtkMesaActor, vtkMesaImageActor, vtkOpenGLActor, vtkOpenGLImageActor, vtkParallelCoordinatesActor, vtkProp3D, vtkQuadricLODActor, vtkScalarBarActor, vtkScaledTextActor, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, and vtkVolume.
| 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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkActor2D, vtkPropAssembly, vtkCompassRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkLegendScaleActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkWidgetRepresentation, vtkActor, vtkAssembly, vtkAxisActor2D, vtkCameraActor, vtkFollower, vtkImageActor, vtkLeaderActor2D, vtkLightActor, vtkLODActor, vtkLODProp3D, vtkMesaActor, vtkMesaImageActor, vtkOpenGLActor, vtkOpenGLImageActor, vtkParallelCoordinatesActor, vtkProp3D, vtkQuadricLODActor, vtkScalarBarActor, vtkScaledTextActor, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, and vtkVolume.
Reimplemented from vtkObject.
Reimplemented in vtkActor2D, vtkPropAssembly, vtkCompassRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkLegendScaleActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkWidgetRepresentation, vtkActor, vtkAssembly, vtkAxisActor2D, vtkCameraActor, vtkFollower, vtkImageActor, vtkLeaderActor2D, vtkLightActor, vtkLODActor, vtkLODProp3D, vtkMesaActor, vtkMesaImageActor, vtkOpenGLActor, vtkOpenGLImageActor, vtkParallelCoordinatesActor, vtkProp3D, vtkQuadricLODActor, vtkScalarBarActor, vtkScaledTextActor, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, and vtkVolume.
| 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 vtkActor2D, vtkPropAssembly, vtkCompassRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkLegendScaleActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkWidgetRepresentation, vtkActor, vtkAssembly, vtkAxisActor2D, vtkCameraActor, vtkFollower, vtkImageActor, vtkLeaderActor2D, vtkLightActor, vtkLODActor, vtkLODProp3D, vtkMesaActor, vtkMesaImageActor, vtkOpenGLActor, vtkOpenGLImageActor, vtkParallelCoordinatesActor, vtkProp3D, vtkQuadricLODActor, vtkScalarBarActor, vtkScaledTextActor, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, and vtkVolume.
| virtual void vtkProp::GetActors | ( | vtkPropCollection * | ) | [inline, virtual] |
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 vtkCompassRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, vtkParallelopipedRepresentation, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkTensorProbeRepresentation, vtkWidgetRepresentation, vtkActor, vtkAssembly, and vtkLODProp3D.
| virtual void vtkProp::GetActors2D | ( | vtkPropCollection * | ) | [inline, virtual] |
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, vtkLegendScaleActor, vtkAffineRepresentation2D, vtkBorderRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSliderRepresentation2D, vtkTextRepresentation, and vtkWidgetRepresentation.
| virtual void vtkProp::GetVolumes | ( | vtkPropCollection * | ) | [inline, virtual] |
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 vtkWidgetRepresentation, vtkAssembly, vtkLODProp3D, and vtkVolume.
| 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 | ( | ) | [inline, virtual] |
Return the mtime of anything that would cause the rendered image to appear differently. Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, textures etc.
Reimplemented in vtkAxesActor, vtkActor, and vtkVolume.
| 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 | ) | [inline, virtual] |
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, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkBoxRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkParallelopipedRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkWidgetRepresentation, vtkActor, vtkAssembly, vtkCameraActor, vtkImageActor, vtkLightActor, vtkLODProp3D, vtkProp3D, vtkTextActor3D, and vtkVolume.
| virtual void vtkProp::ShallowCopy | ( | vtkProp * | prop | ) | [virtual] |
Shallow copy of this vtkProp.
Reimplemented in vtkActor2D, vtkPropAssembly, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkCaptionActor2D, vtkLegendBoxActor, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkConstrainedPointHandleRepresentation, vtkHandleRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkSphereHandleRepresentation, vtkWidgetRepresentation, vtkActor, vtkAssembly, vtkAxisActor2D, vtkFollower, vtkLeaderActor2D, vtkLODActor, vtkLODProp3D, vtkProp3D, vtkQuadricLODActor, vtkScalarBarActor, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, and vtkVolume.
| 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, vtkAssembly, and vtkProp3D.
| 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, and vtkAssembly.
| virtual int vtkProp::GetNumberOfPaths | ( | ) | [inline, 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, and vtkAssembly.
| virtual void vtkProp::PokeMatrix | ( | vtkMatrix4x4 * | vtkNotUsedmatrix | ) | [inline, virtual] |
| virtual vtkMatrix4x4* vtkProp::GetMatrix | ( | ) | [inline, virtual] |
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.
| 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 * | ) | [inline, virtual] |
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 vtkActor2D, vtkPropAssembly, vtkCompassRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkLegendScaleActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAngleRepresentation3D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContourRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkActor, vtkAssembly, vtkAxisActor2D, vtkCameraActor, vtkFollower, vtkImageActor, vtkLeaderActor2D, vtkLightActor, vtkLODActor, vtkLODProp3D, vtkParallelCoordinatesActor, vtkQuadricLODActor, vtkScalarBarActor, vtkTextActor, vtkTextActor3D, and vtkTexturedActor2D.
| virtual int vtkProp::RenderTranslucentPolygonalGeometry | ( | vtkViewport * | ) | [inline, virtual] |
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 vtkActor2D, vtkPropAssembly, vtkAnnotatedCubeActor, vtkAxesActor, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAngleRepresentation3D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContourRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTextRepresentation, vtkActor, vtkAssembly, vtkAxisActor2D, vtkFollower, vtkImageActor, vtkLeaderActor2D, vtkLODProp3D, vtkParallelCoordinatesActor, vtkScalarBarActor, vtkTextActor, vtkTextActor3D, and vtkTexturedActor2D.
| virtual int vtkProp::RenderVolumetricGeometry | ( | vtkViewport * | ) | [inline, virtual] |
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, vtkAssembly, vtkLODProp3D, and vtkVolume.
| virtual int vtkProp::RenderOverlay | ( | vtkViewport * | ) | [inline, virtual] |
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 vtkActor2D, vtkPropAssembly, vtkCompassRepresentation, vtkAxesActor, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkLegendScaleActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAffineRepresentation2D, vtkAngleRepresentation2D, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContourRepresentation, vtkDistanceRepresentation2D, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSliderRepresentation2D, vtkSphereRepresentation, vtkTextRepresentation, vtkAxisActor2D, vtkLeaderActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, vtkTextActor, vtkTextActor3D, and vtkTexturedActor2D.
| 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 | ( | ) | [inline, virtual] |
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 vtkActor2D, vtkPropAssembly, vtkAnnotatedCubeActor, vtkAxesActor, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAngleRepresentation3D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContourRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTextRepresentation, vtkWidgetRepresentation, vtkActor, vtkAssembly, vtkAxisActor2D, vtkCameraActor, vtkFollower, vtkImageActor, vtkLeaderActor2D, vtkLightActor, vtkLODProp3D, vtkParallelCoordinatesActor, vtkScalarBarActor, vtkTextActor, and vtkTextActor3D.
| virtual void vtkProp::ReleaseGraphicsResources | ( | vtkWindow * | ) | [inline, virtual] |
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, vtkCompassRepresentation, vtkAnnotatedCubeActor, vtkAxesActor, vtkAxisActor, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkLegendScaleActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAffineRepresentation2D, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContourRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkWidgetRepresentation, vtkActor, vtkAssembly, vtkAxisActor2D, vtkCameraActor, vtkLeaderActor2D, vtkLightActor, vtkLODActor, vtkLODProp3D, vtkMesaImageActor, vtkOpenGLImageActor, vtkParallelCoordinatesActor, vtkQuadricLODActor, vtkScalarBarActor, vtkTextActor, vtkTextActor3D, vtkTexturedActor2D, and vtkVolume.
| virtual double vtkProp::GetEstimatedRenderTime | ( | vtkViewport * | ) | [inline, virtual] |
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.
| virtual double vtkProp::GetEstimatedRenderTime | ( | ) | [inline, virtual] |
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.
| virtual void vtkProp::SetEstimatedRenderTime | ( | double | t | ) | [inline, virtual] |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.
| virtual void vtkProp::RestoreEstimatedRenderTime | ( | ) | [inline, virtual] |
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.
| virtual void vtkProp::AddEstimatedRenderTime | ( | double | t, | |
| vtkViewport * | vtkNotUsedvp | |||
| ) | [inline, virtual] |
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)
| virtual void vtkProp::SetAllocatedRenderTime | ( | double | t, | |
| vtkViewport * | vtkNotUsedv | |||
| ) | [inline, virtual] |
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.
| 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.
| 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, and vtkAssembly.
| virtual bool vtkProp::GetSupportsSelection | ( | ) | [inline, virtual] |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.
Reimplemented in vtkActor.
| 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] |
int vtkProp::Pickable [protected] |
int vtkProp::Dragable [protected] |
bool vtkProp::UseBounds [protected] |
double vtkProp::AllocatedRenderTime [protected] |
double vtkProp::EstimatedRenderTime [protected] |
double vtkProp::SavedEstimatedRenderTime [protected] |
double vtkProp::RenderTimeMultiplier [protected] |
int vtkProp::NumberOfConsumers [protected] |
vtkObject** vtkProp::Consumers [protected] |
vtkAssemblyPaths* vtkProp::Paths [protected] |
vtkInformation* vtkProp::PropertyKeys [protected] |
The documentation for this class was generated from the following file:
- dox/Common/vtkProp.h
