VTK  9.5.2
vtkQuadricLODActor.h File Reference
#include "vtkActor.h"
#include "vtkRenderingLODModule.h"
Include dependency graph for vtkQuadricLODActor.h:

Go to the source code of this file.

Enumerations

enum  DataConfigurationEnum {
  UNKNOWN = 0 , XLINE , YLINE , ZLINE ,
  XYPLANE , XZPLANE , YZPLANE , XYZVOLUME
}
enum  PropTypeEnum { FOLLOWER = 0 , ACTOR }

Functions

static vtkQuadricLODActorNew ()
void Render (vtkRenderer *, vtkMapper *) override
 This causes the actor to be rendered.
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this actor.
void ShallowCopy (vtkProp *prop) override
 Shallow copy of an LOD actor.
 vtkQuadricLODActor ()
 ~vtkQuadricLODActor () override
virtual void SetDeferLODConstruction (vtkTypeBool)
 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.
virtual vtkTypeBool GetDeferLODConstruction ()
 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.
virtual void DeferLODConstructionOn ()
 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.
virtual void DeferLODConstructionOff ()
 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.
virtual void SetStatic (vtkTypeBool)
 Turn on/off a flag to control whether the underlying pipeline is static.
virtual vtkTypeBool GetStatic ()
 Turn on/off a flag to control whether the underlying pipeline is static.
virtual void StaticOn ()
 Turn on/off a flag to control whether the underlying pipeline is static.
virtual void StaticOff ()
 Turn on/off a flag to control whether the underlying pipeline is static.
virtual void SetDataConfiguration (int)
 Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data.
virtual int GetDataConfiguration ()
 Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data.
void SetDataConfigurationToUnknown ()
 Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data.
void SetDataConfigurationToXLine ()
 Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data.
void SetDataConfigurationToYLine ()
 Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data.
void SetDataConfigurationToZLine ()
 Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data.
void SetDataConfigurationToXYPlane ()
 Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data.
void SetDataConfigurationToYZPlane ()
 Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data.
void SetDataConfigurationToXZPlane ()
 Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data.
void SetDataConfigurationToXYZVolume ()
 Force the binning of the quadric clustering according to application knowledge relative to the dimension of the data.
virtual void SetCollapseDimensionRatio (double)
 If the data configuration is set to UNKNOWN, this class attempts to figure out the dimensionality of the data using CollapseDimensionRatio.
virtual double GetCollapseDimensionRatio ()
 If the data configuration is set to UNKNOWN, this class attempts to figure out the dimensionality of the data using CollapseDimensionRatio.
void SetLODFilter (vtkQuadricClustering *lodFilter)
 This class will create a vtkQuadricClustering algorithm automatically.
virtual vtkQuadricClusteringGetLODFilter ()
 This class will create a vtkQuadricClustering algorithm automatically.
virtual void SetPropType (int)
 Indicate that this actor is actually a follower.
virtual int GetPropType ()
 Indicate that this actor is actually a follower.
void SetPropTypeToFollower ()
 Indicate that this actor is actually a follower.
void SetPropTypeToActor ()
 Indicate that this actor is actually a follower.
void SetCamera (vtkCamera *)
 Set/Get the camera to follow.
virtual vtkCameraGetCamera ()
 Set/Get the camera to follow.

Variables

vtkActorLODActor
vtkPolyDataMapperLODMapper
double CachedInteractiveFrameRate
vtkQuadricClusteringLODFilter
vtkTypeBool Static
double CollapseDimensionRatio
int DataConfiguration
int PropType
vtkCameraCamera
vtkTypeBool DeferLODConstruction
vtkTimeStamp BuildTime
typedef vtkActor Superclass
 Standard class methods.
static vtkTypeBool IsTypeOf (const char *type)
 Standard class methods.
virtual vtkTypeBool IsA (const char *type)
 Standard class methods.
static vtkQuadricLODActorSafeDownCast (vtkObjectBase *o)
 Standard class methods.
virtual vtkObjectBaseNewInstanceInternal () const
 Standard class methods.
vtkQuadricLODActorNewInstance () const
 Standard class methods.
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard class methods.

Typedef Documentation

◆ Superclass

Standard class methods.

Definition at line 65 of file vtkQuadricLODActor.h.

Enumeration Type Documentation

◆ DataConfigurationEnum

Enumerator
UNKNOWN 
XLINE 
YLINE 
ZLINE 
XYPLANE 
XZPLANE 
YZPLANE 
XYZVOLUME 

Definition at line 93 of file vtkQuadricLODActor.h.

◆ PropTypeEnum

Enumerator
FOLLOWER 
ACTOR 

Definition at line 153 of file vtkQuadricLODActor.h.

Function Documentation

◆ New()

vtkQuadricLODActor * New ( )
static

◆ IsTypeOf()

vtkTypeBool IsTypeOf ( const char * type)
static

Standard class methods.

◆ IsA()

virtual vtkTypeBool IsA ( const char * type)
virtual

Standard class methods.

◆ SafeDownCast()

vtkQuadricLODActor * SafeDownCast ( vtkObjectBase * o)
static

Standard class methods.

◆ NewInstanceInternal()

virtual vtkObjectBase * NewInstanceInternal ( ) const
protectedvirtual

Standard class methods.

◆ NewInstance()

vtkQuadricLODActor * NewInstance ( ) const

Standard class methods.

◆ PrintSelf()

void PrintSelf ( ostream & os,
vtkIndent indent )
override

Standard class methods.

◆ SetDeferLODConstruction()

virtual void SetDeferLODConstruction ( vtkTypeBool )
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).

◆ GetDeferLODConstruction()

virtual vtkTypeBool 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).

◆ DeferLODConstructionOn()

virtual void 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).

◆ DeferLODConstructionOff()

virtual void 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).

◆ SetStatic()

virtual void SetStatic ( vtkTypeBool )
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.

◆ GetStatic()

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

◆ StaticOn()

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

◆ StaticOff()

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

◆ SetDataConfiguration()

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

◆ GetDataConfiguration()

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

◆ SetDataConfigurationToUnknown()

void SetDataConfigurationToUnknown ( )

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 121 of file vtkQuadricLODActor.h.

◆ SetDataConfigurationToXLine()

void SetDataConfigurationToXLine ( )

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.

◆ SetDataConfigurationToYLine()

void SetDataConfigurationToYLine ( )

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 123 of file vtkQuadricLODActor.h.

◆ SetDataConfigurationToZLine()

void SetDataConfigurationToZLine ( )

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.

◆ SetDataConfigurationToXYPlane()

void SetDataConfigurationToXYPlane ( )

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 125 of file vtkQuadricLODActor.h.

◆ SetDataConfigurationToYZPlane()

void SetDataConfigurationToYZPlane ( )

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.

◆ SetDataConfigurationToXZPlane()

void SetDataConfigurationToXZPlane ( )

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 127 of file vtkQuadricLODActor.h.

◆ SetDataConfigurationToXYZVolume()

void SetDataConfigurationToXYZVolume ( )

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.

◆ SetCollapseDimensionRatio()

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

◆ GetCollapseDimensionRatio()

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

◆ SetLODFilter()

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

◆ GetLODFilter()

virtual vtkQuadricClustering * 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.

◆ SetPropType()

virtual void SetPropType ( int )
virtual

Indicate that this actor is actually a follower.

By default, the prop type is a vtkActor.

◆ GetPropType()

virtual int GetPropType ( )
virtual

Indicate that this actor is actually a follower.

By default, the prop type is a vtkActor.

◆ SetPropTypeToFollower()

void SetPropTypeToFollower ( )

Indicate that this actor is actually a follower.

By default, the prop type is a vtkActor.

Definition at line 166 of file vtkQuadricLODActor.h.

◆ SetPropTypeToActor()

void SetPropTypeToActor ( )

Indicate that this actor is actually a follower.

By default, the prop type is a vtkActor.

Definition at line 167 of file vtkQuadricLODActor.h.

◆ SetCamera()

void SetCamera ( vtkCamera * )

Set/Get the camera to follow.

This method is only applicable when the prop type is set to a vtkFollower.

◆ GetCamera()

virtual vtkCamera * GetCamera ( )
virtual

Set/Get the camera to follow.

This method is only applicable when the prop type is set to a vtkFollower.

◆ Render()

void Render ( vtkRenderer * ,
vtkMapper *  )
override

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

◆ ReleaseGraphicsResources()

void ReleaseGraphicsResources ( vtkWindow * )
override

Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

◆ ShallowCopy()

void ShallowCopy ( vtkProp * prop)
override

Shallow copy of an LOD actor.

Overloads the virtual vtkProp method.

◆ vtkQuadricLODActor()

vtkQuadricLODActor ( )
protected

◆ ~vtkQuadricLODActor()

~vtkQuadricLODActor ( )
overrideprotected

Variable Documentation

◆ LODActor

vtkActor* LODActor
protected

Definition at line 203 of file vtkQuadricLODActor.h.

◆ LODMapper

vtkPolyDataMapper* LODMapper
protected

Definition at line 204 of file vtkQuadricLODActor.h.

◆ CachedInteractiveFrameRate

double CachedInteractiveFrameRate
protected

Definition at line 207 of file vtkQuadricLODActor.h.

◆ LODFilter

vtkQuadricClustering* LODFilter
protected

Definition at line 210 of file vtkQuadricLODActor.h.

◆ Static

vtkTypeBool Static
protected

Definition at line 213 of file vtkQuadricLODActor.h.

◆ CollapseDimensionRatio

double CollapseDimensionRatio
protected

Definition at line 216 of file vtkQuadricLODActor.h.

◆ DataConfiguration

int DataConfiguration
protected

Definition at line 217 of file vtkQuadricLODActor.h.

◆ PropType

int PropType
protected

Definition at line 220 of file vtkQuadricLODActor.h.

◆ Camera

vtkCamera* Camera
protected

Definition at line 221 of file vtkQuadricLODActor.h.

◆ DeferLODConstruction

vtkTypeBool DeferLODConstruction
protected

Definition at line 224 of file vtkQuadricLODActor.h.

◆ BuildTime

vtkTimeStamp BuildTime
protected

Definition at line 227 of file vtkQuadricLODActor.h.