vtkQuadricLODActor Class Reference

#include <vtkQuadricLODActor.h>

Inheritance diagram for vtkQuadricLODActor:

[legend]

Collaboration diagram for vtkQuadricLODActor:

[legend]

List of all members.

Detailed Description

a specific level-of-detail strategy using the quadric clustering decimation algorithm

vtkQuadricLODActor implements a specific strategy for level-of-detail using the vtkQuadricClustering decimation algorithm. It supports only two levels of detail: full resolution and a decimated version. The decimated LOD is generated using a tuned strategy to produce output consistent with the requested interactive frame rate (i.e., the vtkRenderWindowInteractor's DesiredUpdateRate). It also makes use of display lists for performance, and adjusts the vtkQuadricClustering algorithm to take into account the dimensionality of the data (e.g., 2D, x-y surfaces may be binned into n x n x 1 to reduce extra polygons in the z-direction). Finally, the filter may optionally be set in "Static" mode (this works with the vtkMapper::SetStatic() method). `Enabling Static results in a one time execution of the Mapper's pipeline. After that, the pipeline no longer updated (unless manually forced to do so).

Warning:: By default the algorithm is set up to pre-compute the LODs. That is, on the first render (whether a full resolution render or interactive render) the LOD is computed. This behavior can be changed so that the LOD construction is deferred until the first interactive render. Either way, when the LOD is constructed, the user may notice a short pause.
This class can be used as a direct replacement for vtkActor. It may also be used as a replacement for vtkFollower's (the ability to track a camera is provided).

See also:: vtkLODActor vtkQuadricClustering

Tests:: vtkQuadricLODActor (Tests)

Definition at line 62 of file vtkQuadricLODActor.h.


typedef vtkActor	Superclass
static int	IsTypeOf (const char *type)
static vtkQuadricLODActor *	SafeDownCast (vtkObject *o)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
Public Types
enum	DataConfigurationEnum { UNKNOWN = 0, XLINE, YLINE, ZLINE, XYPLANE, XZPLANE, YZPLANE, XYZVOLUME }
enum	PropTypeEnum { FOLLOWER = 0, ACTOR }
Public Member Functions
virtual void	Render (vtkRenderer , vtkMapper )
int	RenderOpaqueGeometry (vtkViewport *viewport)
void	ReleaseGraphicsResources (vtkWindow *)
void	ShallowCopy (vtkProp *prop)

virtual void	SetDeferLODConstruction (int)
virtual int	GetDeferLODConstruction ()
virtual void	DeferLODConstructionOn ()
virtual void	DeferLODConstructionOff ()

virtual void	SetStatic (int)
virtual int	GetStatic ()
virtual void	StaticOn ()
virtual void	StaticOff ()

virtual void	SetDataConfiguration (int)
virtual int	GetDataConfiguration ()
void	SetDataConfigurationToUnknown ()
void	SetDataConfigurationToXLine ()
void	SetDataConfigurationToYLine ()
void	SetDataConfigurationToZLine ()
void	SetDataConfigurationToXYPlane ()
void	SetDataConfigurationToYZPlane ()
void	SetDataConfigurationToXZPlane ()
void	SetDataConfigurationToXYZVolume ()

virtual void	SetCollapseDimensionRatio (double)
virtual double	GetCollapseDimensionRatio ()

void	SetLODFilter (vtkQuadricClustering *lodFilter)
virtual vtkQuadricClustering *	GetLODFilter ()

virtual void	SetMaximumDisplayListSize (int)
virtual int	GetMaximumDisplayListSize ()

virtual void	SetPropType (int)
virtual int	GetPropType ()
void	SetPropTypeToFollower ()
void	SetPropTypeToActor ()

void	SetCamera (vtkCamera *)
virtual vtkCamera *	GetCamera ()
Static Public Member Functions
static vtkQuadricLODActor *	New ()
Protected Member Functions
	vtkQuadricLODActor ()
	~vtkQuadricLODActor ()
vtkIdType	GetDisplayListSize (vtkPolyData *pd)
Protected Attributes
vtkActor *	LODActor
vtkPolyDataMapper *	LODMapper
double	CachedInteractiveFrameRate
vtkQuadricClustering *	LODFilter
int	Static
double	CollapseDimensionRatio
int	DataConfiguration
int	PropType
vtkCamera *	Camera
int	MaximumDisplayListSize
int	DeferLODConstruction
vtkTimeStamp	BuildTime

Member Typedef Documentation

typedef vtkActor vtkQuadricLODActor::Superclass

Standard class methods.

Reimplemented from vtkActor.

Definition at line 70 of file vtkQuadricLODActor.h.

Member Enumeration Documentation

enum vtkQuadricLODActor::DataConfigurationEnum

Enumerator:

UNKNOWN
XLINE
YLINE
ZLINE
XYPLANE
XZPLANE
YZPLANE
XYZVOLUME

Definition at line 96 of file vtkQuadricLODActor.h.

enum vtkQuadricLODActor::PropTypeEnum

Enumerator:

FOLLOWER
ACTOR

Definition at line 168 of file vtkQuadricLODActor.h.

Constructor & Destructor Documentation

vtkQuadricLODActor::vtkQuadricLODActor ( ) [protected]

vtkQuadricLODActor::~vtkQuadricLODActor ( ) [protected]

Member Function Documentation

static vtkQuadricLODActor* vtkQuadricLODActor::New ( ) [static]

Creates a vtkQuadricLODActor.

Reimplemented from vtkActor.

virtual const char* vtkQuadricLODActor::GetClassName ( ) [virtual]

Standard class methods.

Reimplemented from vtkActor.

static int vtkQuadricLODActor::IsTypeOf ( const char * type ) [static]

Standard class methods.

Reimplemented from vtkActor.

virtual int vtkQuadricLODActor::IsA ( const char * type ) [virtual]

Standard class methods.

Reimplemented from vtkActor.

static vtkQuadricLODActor* vtkQuadricLODActor::SafeDownCast ( vtkObject * o ) [static]

Standard class methods.

Reimplemented from vtkActor.

void vtkQuadricLODActor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Standard class methods.

Reimplemented from vtkActor.

virtual void vtkQuadricLODActor::SetDeferLODConstruction ( int ) [virtual]

Specify whether to build the LOD immediately (i.e., on the first render) or to wait until the LOD is requested in a subsequent render. By default, LOD construction is not deferred (DeferLODConstruction is false).

virtual int vtkQuadricLODActor::GetDeferLODConstruction ( ) [virtual]

Specify whether to build the LOD immediately (i.e., on the first render) or to wait until the LOD is requested in a subsequent render. By default, LOD construction is not deferred (DeferLODConstruction is false).

virtual void vtkQuadricLODActor::DeferLODConstructionOn ( ) [virtual]

Specify whether to build the LOD immediately (i.e., on the first render) or to wait until the LOD is requested in a subsequent render. By default, LOD construction is not deferred (DeferLODConstruction is false).

virtual void vtkQuadricLODActor::DeferLODConstructionOff ( ) [virtual]

Specify whether to build the LOD immediately (i.e., on the first render) or to wait until the LOD is requested in a subsequent render. By default, LOD construction is not deferred (DeferLODConstruction is false).

virtual void vtkQuadricLODActor::SetStatic ( int ) [virtual]

Turn on/off a flag to control whether the underlying pipeline is static. If static, this means that the data pipeline executes once and then not again until the user manually modifies this class. By default, Static is off because trying to debug this is tricky, and you should only use it when you know what you are doing.

virtual int vtkQuadricLODActor::GetStatic ( ) [virtual]

Turn on/off a flag to control whether the underlying pipeline is static. If static, this means that the data pipeline executes once and then not again until the user manually modifies this class. By default, Static is off because trying to debug this is tricky, and you should only use it when you know what you are doing.

virtual void vtkQuadricLODActor::StaticOn ( ) [virtual]

Turn on/off a flag to control whether the underlying pipeline is static. If static, this means that the data pipeline executes once and then not again until the user manually modifies this class. By default, Static is off because trying to debug this is tricky, and you should only use it when you know what you are doing.

virtual void vtkQuadricLODActor::StaticOff ( ) [virtual]

Turn on/off a flag to control whether the underlying pipeline is static. If static, this means that the data pipeline executes once and then not again until the user manually modifies this class. By default, Static is off because trying to debug this is tricky, and you should only use it when you know what you are doing.

virtual void vtkQuadricLODActor::SetDataConfiguration ( int ) [virtual]

Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data. For example, if you know your data lies in a 2D x-y plane, the performance of the quadric clustering algorithm can be greatly improved by indicating this (i.e., the number of resulting triangles, and the quality of the decimation version is better). Setting this parameter forces the binning to be configured consistent with the dimnesionality of the data, and the collapse dimension ratio is ignored. Specifying the value of DataConfiguration to UNKNOWN (the default value) means that the class will attempt to figure the dimension of the class automatically using the CollapseDimensionRatio ivar.

virtual int vtkQuadricLODActor::GetDataConfiguration ( ) [virtual]

Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data. For example, if you know your data lies in a 2D x-y plane, the performance of the quadric clustering algorithm can be greatly improved by indicating this (i.e., the number of resulting triangles, and the quality of the decimation version is better). Setting this parameter forces the binning to be configured consistent with the dimnesionality of the data, and the collapse dimension ratio is ignored. Specifying the value of DataConfiguration to UNKNOWN (the default value) means that the class will attempt to figure the dimension of the class automatically using the CollapseDimensionRatio ivar.

void vtkQuadricLODActor::SetDataConfigurationToUnknown ( ) [inline]

Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data. For example, if you know your data lies in a 2D x-y plane, the performance of the quadric clustering algorithm can be greatly improved by indicating this (i.e., the number of resulting triangles, and the quality of the decimation version is better). Setting this parameter forces the binning to be configured consistent with the dimnesionality of the data, and the collapse dimension ratio is ignored. Specifying the value of DataConfiguration to UNKNOWN (the default value) means that the class will attempt to figure the dimension of the class automatically using the CollapseDimensionRatio ivar.

Definition at line 118 of file vtkQuadricLODActor.h.

void vtkQuadricLODActor::SetDataConfigurationToXLine ( ) [inline]

Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data. For example, if you know your data lies in a 2D x-y plane, the performance of the quadric clustering algorithm can be greatly improved by indicating this (i.e., the number of resulting triangles, and the quality of the decimation version is better). Setting this parameter forces the binning to be configured consistent with the dimnesionality of the data, and the collapse dimension ratio is ignored. Specifying the value of DataConfiguration to UNKNOWN (the default value) means that the class will attempt to figure the dimension of the class automatically using the CollapseDimensionRatio ivar.

Definition at line 120 of file vtkQuadricLODActor.h.

void vtkQuadricLODActor::SetDataConfigurationToYLine ( ) [inline]

Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data. For example, if you know your data lies in a 2D x-y plane, the performance of the quadric clustering algorithm can be greatly improved by indicating this (i.e., the number of resulting triangles, and the quality of the decimation version is better). Setting this parameter forces the binning to be configured consistent with the dimnesionality of the data, and the collapse dimension ratio is ignored. Specifying the value of DataConfiguration to UNKNOWN (the default value) means that the class will attempt to figure the dimension of the class automatically using the CollapseDimensionRatio ivar.

Definition at line 122 of file vtkQuadricLODActor.h.

void vtkQuadricLODActor::SetDataConfigurationToZLine ( ) [inline]

Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data. For example, if you know your data lies in a 2D x-y plane, the performance of the quadric clustering algorithm can be greatly improved by indicating this (i.e., the number of resulting triangles, and the quality of the decimation version is better). Setting this parameter forces the binning to be configured consistent with the dimnesionality of the data, and the collapse dimension ratio is ignored. Specifying the value of DataConfiguration to UNKNOWN (the default value) means that the class will attempt to figure the dimension of the class automatically using the CollapseDimensionRatio ivar.

Definition at line 124 of file vtkQuadricLODActor.h.

void vtkQuadricLODActor::SetDataConfigurationToXYPlane ( ) [inline]

Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data. For example, if you know your data lies in a 2D x-y plane, the performance of the quadric clustering algorithm can be greatly improved by indicating this (i.e., the number of resulting triangles, and the quality of the decimation version is better). Setting this parameter forces the binning to be configured consistent with the dimnesionality of the data, and the collapse dimension ratio is ignored. Specifying the value of DataConfiguration to UNKNOWN (the default value) means that the class will attempt to figure the dimension of the class automatically using the CollapseDimensionRatio ivar.

Definition at line 126 of file vtkQuadricLODActor.h.

void vtkQuadricLODActor::SetDataConfigurationToYZPlane ( ) [inline]

Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data. For example, if you know your data lies in a 2D x-y plane, the performance of the quadric clustering algorithm can be greatly improved by indicating this (i.e., the number of resulting triangles, and the quality of the decimation version is better). Setting this parameter forces the binning to be configured consistent with the dimnesionality of the data, and the collapse dimension ratio is ignored. Specifying the value of DataConfiguration to UNKNOWN (the default value) means that the class will attempt to figure the dimension of the class automatically using the CollapseDimensionRatio ivar.

Definition at line 128 of file vtkQuadricLODActor.h.

void vtkQuadricLODActor::SetDataConfigurationToXZPlane ( ) [inline]

Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data. For example, if you know your data lies in a 2D x-y plane, the performance of the quadric clustering algorithm can be greatly improved by indicating this (i.e., the number of resulting triangles, and the quality of the decimation version is better). Setting this parameter forces the binning to be configured consistent with the dimnesionality of the data, and the collapse dimension ratio is ignored. Specifying the value of DataConfiguration to UNKNOWN (the default value) means that the class will attempt to figure the dimension of the class automatically using the CollapseDimensionRatio ivar.

Definition at line 130 of file vtkQuadricLODActor.h.

void vtkQuadricLODActor::SetDataConfigurationToXYZVolume ( ) [inline]

Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data. For example, if you know your data lies in a 2D x-y plane, the performance of the quadric clustering algorithm can be greatly improved by indicating this (i.e., the number of resulting triangles, and the quality of the decimation version is better). Setting this parameter forces the binning to be configured consistent with the dimnesionality of the data, and the collapse dimension ratio is ignored. Specifying the value of DataConfiguration to UNKNOWN (the default value) means that the class will attempt to figure the dimension of the class automatically using the CollapseDimensionRatio ivar.

Definition at line 132 of file vtkQuadricLODActor.h.

virtual void vtkQuadricLODActor::SetCollapseDimensionRatio ( double ) [virtual]

If the data configuration is set to UNKNOWN, this class attempts to figure out the dimensionality of the data using CollapseDimensionRatio. This ivar is the ratio of short edge of the input bounding box to its long edge, which is then used to collapse the data dimension (and set the quadric bin size in that direction to one). By default, this value is 0.05.

virtual double vtkQuadricLODActor::GetCollapseDimensionRatio ( ) [virtual]

If the data configuration is set to UNKNOWN, this class attempts to figure out the dimensionality of the data using CollapseDimensionRatio. This ivar is the ratio of short edge of the input bounding box to its long edge, which is then used to collapse the data dimension (and set the quadric bin size in that direction to one). By default, this value is 0.05.

void vtkQuadricLODActor::SetLODFilter ( vtkQuadricClustering * lodFilter )

This class will create a vtkQuadricClustering algorithm automatically. However, if you would like to specify the filter to use, or to access it and configure it, these method provide access to the filter.

virtual vtkQuadricClustering* vtkQuadricLODActor::GetLODFilter ( ) [virtual]

This class will create a vtkQuadricClustering algorithm automatically. However, if you would like to specify the filter to use, or to access it and configure it, these method provide access to the filter.

virtual void vtkQuadricLODActor::SetMaximumDisplayListSize ( int ) [virtual]

Specify the maximum display list size. This variable is used to determine whether to use display lists (ImmediateModeRenderingOff) or not. Controlling display list size is important to prevent program crashes (i.e., overly large display lists on some graphics hardware will cause faults). The display list size is the length of the vtkCellArray representing the topology of the input vtkPolyData.

virtual int vtkQuadricLODActor::GetMaximumDisplayListSize ( ) [virtual]

Specify the maximum display list size. This variable is used to determine whether to use display lists (ImmediateModeRenderingOff) or not. Controlling display list size is important to prevent program crashes (i.e., overly large display lists on some graphics hardware will cause faults). The display list size is the length of the vtkCellArray representing the topology of the input vtkPolyData.

virtual void vtkQuadricLODActor::SetPropType ( int ) [virtual]

Indicate that this actor is actually a follower. By default, the prop type is a vtkActor.

virtual int vtkQuadricLODActor::GetPropType ( ) [virtual]

Indicate that this actor is actually a follower. By default, the prop type is a vtkActor.

void vtkQuadricLODActor::SetPropTypeToFollower ( ) [inline]

Indicate that this actor is actually a follower. By default, the prop type is a vtkActor.

Definition at line 179 of file vtkQuadricLODActor.h.

void vtkQuadricLODActor::SetPropTypeToActor ( ) [inline]

Indicate that this actor is actually a follower. By default, the prop type is a vtkActor.

Definition at line 181 of file vtkQuadricLODActor.h.

void vtkQuadricLODActor::SetCamera ( vtkCamera * )

Set/Get the camera to follow. This method is only applicable when the prop type is set to a vtkFollower.

virtual vtkCamera* vtkQuadricLODActor::GetCamera ( ) [virtual]

Set/Get the camera to follow. This method is only applicable when the prop type is set to a vtkFollower.

virtual void vtkQuadricLODActor::Render	(	vtkRenderer *	,
		vtkMapper *
	)			`[virtual]`

This causes the actor to be rendered. Depending on the frame rate request, it will use either a full resolution render or an interactive render (i.e., it will use the decimated geometry).

Reimplemented from vtkActor.

int vtkQuadricLODActor::RenderOpaqueGeometry ( vtkViewport * viewport ) [virtual]

This method is used internally by the rendering process. We overide the superclass method to properly set the estimated render time.

Reimplemented from vtkActor.

void vtkQuadricLODActor::ReleaseGraphicsResources ( vtkWindow * ) [virtual]

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

void vtkQuadricLODActor::ShallowCopy ( vtkProp * prop ) [virtual]

Shallow copy of an LOD actor. Overloads the virtual vtkProp method.

Reimplemented from vtkActor.

vtkIdType vtkQuadricLODActor::GetDisplayListSize ( vtkPolyData * pd ) [protected]