Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

vtkLODProp3D Class Reference

level of detail 3D prop. More...

#include <vtkLODProp3D.h>

Inheritance diagram for vtkLODProp3D:

[legend]Collaboration diagram for vtkLODProp3D:

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
float *	GetBounds ()
void	GetBounds (float bounds[6])
int	RequiresRayCasting ()
int	RequiresRenderingIntoImage ()
int	AddLOD (vtkMapper m, vtkProperty p, vtkTexture *t, float time)
int	AddLOD (vtkMapper m, vtkProperty p, float time)
int	AddLOD (vtkMapper m, vtkTexture t, float time)
int	AddLOD (vtkMapper *m, float time)
int	AddLOD (vtkVolumeMapper m, vtkVolumeProperty p, float time)
int	AddLOD (vtkVolumeMapper *m, float time)
void	RemoveLOD (int id)
void	SetLODProperty (int id, vtkProperty *p)
void	GetLODProperty (int id, vtkProperty **p)
void	SetLODProperty (int id, vtkVolumeProperty *p)
void	GetLODProperty (int id, vtkVolumeProperty **p)
void	SetLODMapper (int id, vtkMapper *m)
void	GetLODMapper (int id, vtkMapper **m)
void	SetLODMapper (int id, vtkVolumeMapper *m)
void	GetLODMapper (int id, vtkVolumeMapper **m)
void	SetLODTexture (int id, vtkTexture *t)
void	GetLODTexture (int id, vtkTexture **t)
void	EnableLOD (int id)
void	DisableLOD (int id)
void	SetLODLevel (int id, float level)
float	GetLODLevel (int id)
float	GetLODIndexLevel (int index)
float	GetLODEstimatedRenderTime (int id)
float	GetLODIndexEstimatedRenderTime (int index)
virtual void	SetAutomaticLODSelection (int)
virtual int	GetAutomaticLODSelection ()
virtual void	AutomaticLODSelectionOn ()
virtual void	AutomaticLODSelectionOff ()
virtual void	SetSelectedLODID (int)
virtual int	GetSelectedLODID ()
int	GetLastRenderedLODID ()
virtual void	GetActors (vtkPropCollection *)
void	SetPickMethod (void(f)(void ), void *arg)
void	SetPickMethodArgDelete (void(f)(void ))
void	SetSelectedPickLODID (int id)
virtual int	GetSelectedPickLODID ()
virtual void	SetAutomaticPickLODSelection (int)
virtual int	GetAutomaticPickLODSelection ()
virtual void	AutomaticPickLODSelectionOn ()
virtual void	AutomaticPickLODSelectionOff ()
void	ShallowCopy (vtkProp *prop)
int	RenderOpaqueGeometry (vtkViewport *viewport)
int	RenderTranslucentGeometry (vtkViewport *viewport)
int	RenderIntoImage (vtkViewport *viewport)
int	CastViewRay (VTKRayCastRayInfo *rayInfo)
int	InitializeRayCasting (vtkViewport *viewport)
void	ReleaseGraphicsResources (vtkWindow *)
void	SetAllocatedRenderTime (float t, vtkViewport *vp)
void	RestoreEstimatedRenderTime ()
virtual void	AddEstimatedRenderTime (float t, vtkViewport *vp)
Static Public Methods
vtkLODProp3D *	New ()
int	IsTypeOf (const char *type)
vtkLODProp3D *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkLODProp3D ()
	~vtkLODProp3D ()
	vtkLODProp3D (const vtkLODProp3D &)
void	operator= (const vtkLODProp3D &)
int	GetAutomaticPickPropIndex (void)
int	GetNextEntryIndex ()
int	ConvertIDToIndex (int id)
Protected Attributes
vtkLODProp3DEntry *	LODs
int	NumberOfEntries
int	NumberOfLODs
int	CurrentIndex
int	SelectedLODIndex
int	AutomaticLODSelection
int	SelectedLODID
int	SelectedPickLODID
int	AutomaticPickLODSelection
vtkProp *	PreviousPickProp
void(*	PreviousPickMethod )(void *)
void *	PreviousPickMethodArg

Detailed Description

level of detail 3D prop.

Date:: 2000/12/10 20:08:41

Revision:: 1.19

vtkLODProp3D is a class to support level of detail rendering for Prop3D. Any number of mapper/property/texture items can be added to this object. Render time will be measured, and will be used to select a LOD based on the AllocatedRenderTime of this Prop3D. Depending on the type of the mapper/property, a vtkActor or a vtkVolume will be created behind the scenes.

See also:: vtkProp3D vtkActor vtkVolume vtkLODActor

Examples:: vtkLODProp3D (examples)

Definition at line 82 of file vtkLODProp3D.h.

Constructor & Destructor Documentation

vtkLODProp3D::vtkLODProp3D ( ) [protected]

vtkLODProp3D::~vtkLODProp3D ( ) [protected]

vtkLODProp3D::vtkLODProp3D ( const vtkLODProp3D & ) [inline, protected]

Definition at line 238 of file vtkLODProp3D.h.

Member Function Documentation

vtkLODProp3D* vtkLODProp3D::New ( ) [static]

Create an instance of this class.
Reimplemented from vtkProp.

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

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

int vtkLODProp3D::IsTypeOf ( const char * type ) [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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkProp3D.

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

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkProp3D.

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

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

void vtkLODProp3D::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 vtkProp3D.

float* vtkLODProp3D::GetBounds ( ) [virtual]

Standard vtkProp method to get 3D bounds of a 3D prop
Reimplemented from vtkProp3D.

void vtkLODProp3D::GetBounds ( float bounds[6] ) [inline]

Get the bounds for this Prop3D as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
Reimplemented from vtkProp3D.
Definition at line 93 of file vtkLODProp3D.h.

int vtkLODProp3D::RequiresRayCasting ( ) [virtual]

Do we need to ray cast this prop?
Reimplemented from vtkProp.

int vtkLODProp3D::RequiresRenderingIntoImage ( ) [virtual]

Does this prop render into an image?
Reimplemented from vtkProp.

int vtkLODProp3D::AddLOD ( vtkMapper * m,

vtkProperty * p,

vtkTexture * t,

float time

)

Add a level of detail with a given mapper, property, texture, and guess of rendering time. The property and texture fields can be set to NULL (the other methods are included for script access where null variables are not allowed). The time field can be set to 0.0 indicating that no initial guess for rendering time is being supplied. The returned integer value is an ID that can be used later to delete this LOD, or set it as the selected LOD.

int vtkLODProp3D::AddLOD ( vtkMapper * m,

vtkProperty * p,

float time

)

int vtkLODProp3D::AddLOD ( vtkMapper * m,

vtkTexture * t,

float time

)

int vtkLODProp3D::AddLOD ( vtkMapper * m,

float time

)

int vtkLODProp3D::AddLOD ( vtkVolumeMapper * m,

vtkVolumeProperty * p,

float time

)

int vtkLODProp3D::AddLOD ( vtkVolumeMapper * m,

float time

)

void vtkLODProp3D::RemoveLOD ( int id )

Delete a level of detail given an ID. This is the ID returned by the AddLOD method

void vtkLODProp3D::SetLODProperty ( int id,

vtkProperty * p

)

Methods to set / get the property of an LOD. Since the LOD could be a volume or an actor, you have to pass in the pointer to the property to get it. The returned property will be NULL if the id is not valid, or the property is of the wrong type for the corresponding Prop3D.

void vtkLODProp3D::GetLODProperty ( int id,

vtkProperty ** p

)

void vtkLODProp3D::SetLODProperty ( int id,

vtkVolumeProperty * p

)

void vtkLODProp3D::GetLODProperty ( int id,

vtkVolumeProperty ** p

)

void vtkLODProp3D::SetLODMapper ( int id,

vtkMapper * m

)

Methods to set / get the mapper of an LOD. Since the LOD could be a volume or an actor, you have to pass in the pointer to the mapper to get it. The returned mapper will be NULL if the id is not valid, or the mapper is of the wrong type for the corresponding Prop3D.

void vtkLODProp3D::GetLODMapper ( int id,

vtkMapper ** m

)

void vtkLODProp3D::SetLODMapper ( int id,

vtkVolumeMapper * m

)

void vtkLODProp3D::GetLODMapper ( int id,

vtkVolumeMapper ** m

)

void vtkLODProp3D::SetLODTexture ( int id,

vtkTexture * t

)

Methods to set / get the texture of an LOD. This method is only valid for LOD ids that are Actors (not Volumes)

void vtkLODProp3D::GetLODTexture ( int id,

vtkTexture ** t

)

void vtkLODProp3D::EnableLOD ( int id )

Enable / disable a particular LOD. If it is disabled, it will not be used during automatic selection, but can be selected as the LOD if automatic LOD selection is off.

void vtkLODProp3D::DisableLOD ( int id )

void vtkLODProp3D::SetLODLevel ( int id,

float level

)

Set the level of a particular LOD. When a LOD is selected for rendering because it has the largest render time that fits within the allocated time, all LOD are then checked to see if any one can render faster but has a lower (more resolution/better) level. This quantity is a float to ensure that a level can be inserted between 2 and 3.

float vtkLODProp3D::GetLODLevel ( int id )

float vtkLODProp3D::GetLODIndexLevel ( int index )

float vtkLODProp3D::GetLODEstimatedRenderTime ( int id )

Access method that can be used to find out the estimated render time (the thing used to select an LOD) for a given LOD ID or index. Value is returned in seconds.

float vtkLODProp3D::GetLODIndexEstimatedRenderTime ( int index )

virtual void vtkLODProp3D::SetAutomaticLODSelection ( int ) [virtual]

Turn on / off automatic selection of LOD. This is on by default. If it is off, then the SelectedLODID is rendered regardless of rendering time or desired update rate.

virtual int vtkLODProp3D::GetAutomaticLODSelection ( ) [virtual]

virtual void vtkLODProp3D::AutomaticLODSelectionOn ( ) [virtual]

virtual void vtkLODProp3D::AutomaticLODSelectionOff ( ) [virtual]

virtual void vtkLODProp3D::SetSelectedLODID ( int ) [virtual]

Set the id of the LOD that is to be drawn when automatic LOD selection is turned off.

virtual int vtkLODProp3D::GetSelectedLODID ( ) [virtual]

int vtkLODProp3D::GetLastRenderedLODID ( )

Get the ID of the previously (during the last render) selected LOD index

virtual void vtkLODProp3D::GetActors ( vtkPropCollection * ) [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 from vtkProp.

void vtkLODProp3D::SetPickMethod ( void(* f)(void *),

void * arg

)

This method is invoked when an instance of vtkProp (or subclass, e.g., vtkActor) is picked by vtkPicker.
Reimplemented from vtkProp.

void vtkLODProp3D::SetPickMethodArgDelete ( void(* f)(void *) )

Reimplemented from vtkProp.

void vtkLODProp3D::SetSelectedPickLODID ( int id )

Set the id of the LOD that is to be used for picking when automatic LOD pick selection is turned off.

virtual int vtkLODProp3D::GetSelectedPickLODID ( ) [virtual]

virtual void vtkLODProp3D::SetAutomaticPickLODSelection ( int ) [virtual]

Turn on / off automatic selection of picking LOD. This is on by default. If it is off, then the SelectedLODID is rendered regardless of rendering time or desired update rate.

virtual int vtkLODProp3D::GetAutomaticPickLODSelection ( ) [virtual]

virtual void vtkLODProp3D::AutomaticPickLODSelectionOn ( ) [virtual]

virtual void vtkLODProp3D::AutomaticPickLODSelectionOff ( ) [virtual]

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

Shallow copy of this vtkLODProp3D.
Reimplemented from vtkProp3D.

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

Support the standard render methods.
Reimplemented from vtkProp.

int vtkLODProp3D::RenderTranslucentGeometry ( vtkViewport * viewport ) [virtual]

Reimplemented from vtkProp.

int vtkLODProp3D::RenderIntoImage ( vtkViewport * viewport ) [virtual]

Reimplemented from vtkProp.

int vtkLODProp3D::CastViewRay ( VTKRayCastRayInfo * rayInfo ) [virtual]

Reimplemented from vtkProp.

int vtkLODProp3D::InitializeRayCasting ( vtkViewport * viewport ) [virtual]

Reimplemented from vtkProp.

void vtkLODProp3D::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 vtkProp.

void vtkLODProp3D::SetAllocatedRenderTime ( float t,

vtkViewport * vp

)

Used by the culler / renderer to set the allocated render time for this prop. This is based on the desired update rate, and possibly some other properties such as potential screen coverage of this prop.

void vtkLODProp3D::RestoreEstimatedRenderTime ( ) [virtual]

Used when the render process is aborted to restore the previous estimated render time. Overridden here to allow previous time for a particular LOD to be restored - otherwise the time for the last rendered LOD will be copied into the currently selected LOD.
Reimplemented from vtkProp.

virtual void vtkLODProp3D::AddEstimatedRenderTime ( float t,

vtkViewport * vp

) [virtual]

Override method from vtkProp in order to push this call down to the selected LOD as well.

void vtkLODProp3D::operator= ( const vtkLODProp3D & ) [inline, protected]

Definition at line 239 of file vtkLODProp3D.h.

int vtkLODProp3D::GetAutomaticPickPropIndex ( void ) [protected]

int vtkLODProp3D::GetNextEntryIndex ( ) [protected]

int vtkLODProp3D::ConvertIDToIndex ( int id ) [protected]

Member Data Documentation

vtkLODProp3DEntry* vtkLODProp3D::LODs [protected]

Definition at line 243 of file vtkLODProp3D.h.

int vtkLODProp3D::NumberOfEntries [protected]

Definition at line 244 of file vtkLODProp3D.h.

int vtkLODProp3D::NumberOfLODs [protected]

Definition at line 245 of file vtkLODProp3D.h.

int vtkLODProp3D::CurrentIndex [protected]

Definition at line 246 of file vtkLODProp3D.h.

int vtkLODProp3D::SelectedLODIndex [protected]

Definition at line 250 of file vtkLODProp3D.h.

int vtkLODProp3D::AutomaticLODSelection [protected]

Definition at line 252 of file vtkLODProp3D.h.

int vtkLODProp3D::SelectedLODID [protected]

Definition at line 253 of file vtkLODProp3D.h.

int vtkLODProp3D::SelectedPickLODID [protected]

Definition at line 254 of file vtkLODProp3D.h.

int vtkLODProp3D::AutomaticPickLODSelection [protected]

Definition at line 255 of file vtkLODProp3D.h.

vtkProp* vtkLODProp3D::PreviousPickProp [protected]

Definition at line 256 of file vtkLODProp3D.h.

void(* vtkLODProp3D::PreviousPickMethod)(void *) [protected]

void* vtkLODProp3D::PreviousPickMethodArg [protected]

Definition at line 258 of file vtkLODProp3D.h.

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

graphics/vtkLODProp3D.h

Generated on Wed Nov 21 12:52:49 2001 for VTK by

vtkLODProp3D Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation