VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkLODProp3D Class Reference

level of detail 3D prop More...

#include <vtkLODProp3D.h>

Inheritance diagram for vtkLODProp3D:
[legend]
Collaboration diagram for vtkLODProp3D:
[legend]

Public Types

typedef vtkProp3D Superclass
 
- Public Types inherited from vtkProp3D
typedef vtkProp Superclass
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkLODProp3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
double * GetBounds () override
 Standard vtkProp method to get 3D bounds of a 3D prop. More...
 
void GetBounds (double bounds[6])
 
int AddLOD (vtkMapper *m, vtkProperty *p, vtkProperty *back, vtkTexture *t, double time)
 Add a level of detail with a given mapper, property, backface property, texture, and guess of rendering time. More...
 
int AddLOD (vtkMapper *m, vtkProperty *p, vtkTexture *t, double time)
 
int AddLOD (vtkMapper *m, vtkProperty *p, vtkProperty *back, double time)
 
int AddLOD (vtkMapper *m, vtkProperty *p, double time)
 
int AddLOD (vtkMapper *m, vtkTexture *t, double time)
 
int AddLOD (vtkMapper *m, double time)
 
int AddLOD (vtkAbstractVolumeMapper *m, vtkVolumeProperty *p, double time)
 
int AddLOD (vtkAbstractVolumeMapper *m, double time)
 
int AddLOD (vtkImageMapper3D *m, vtkImageProperty *p, double time)
 
int AddLOD (vtkImageMapper3D *m, double time)
 
virtual int GetNumberOfLODs ()
 Get the current number of LODs. More...
 
virtual int GetCurrentIndex ()
 Get the current index, used to determine the ID of the next LOD that is added. More...
 
void RemoveLOD (int id)
 Delete a level of detail given an ID. More...
 
void SetLODProperty (int id, vtkProperty *p)
 Methods to set / get the property of an LOD. More...
 
void GetLODProperty (int id, vtkProperty **p)
 
void SetLODProperty (int id, vtkVolumeProperty *p)
 
void GetLODProperty (int id, vtkVolumeProperty **p)
 
void SetLODProperty (int id, vtkImageProperty *p)
 
void GetLODProperty (int id, vtkImageProperty **p)
 
void SetLODMapper (int id, vtkMapper *m)
 Methods to set / get the mapper of an LOD. More...
 
void GetLODMapper (int id, vtkMapper **m)
 
void SetLODMapper (int id, vtkAbstractVolumeMapper *m)
 
void GetLODMapper (int id, vtkAbstractVolumeMapper **m)
 
void SetLODMapper (int id, vtkImageMapper3D *m)
 
void GetLODMapper (int id, vtkImageMapper3D **m)
 
vtkAbstractMapper3DGetLODMapper (int id)
 Get the LODMapper as an vtkAbstractMapper3D. More...
 
void SetLODBackfaceProperty (int id, vtkProperty *t)
 Methods to set / get the backface property of an LOD. More...
 
void GetLODBackfaceProperty (int id, vtkProperty **t)
 
void SetLODTexture (int id, vtkTexture *t)
 Methods to set / get the texture of an LOD. More...
 
void GetLODTexture (int id, vtkTexture **t)
 
void EnableLOD (int id)
 Enable / disable a particular LOD. More...
 
void DisableLOD (int id)
 
int IsLODEnabled (int id)
 
void SetLODLevel (int id, double level)
 Set the level of a particular LOD. More...
 
double GetLODLevel (int id)
 
double GetLODIndexLevel (int index)
 
double 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. More...
 
double GetLODIndexEstimatedRenderTime (int index)
 
virtual void SetAutomaticLODSelection (vtkTypeBool)
 Turn on / off automatic selection of LOD. More...
 
virtual vtkTypeBool GetAutomaticLODSelection ()
 
virtual void AutomaticLODSelectionOn ()
 
virtual void AutomaticLODSelectionOff ()
 
virtual void SetSelectedLODID (int)
 Set the id of the LOD that is to be drawn when automatic LOD selection is turned off. More...
 
virtual int GetSelectedLODID ()
 
int GetLastRenderedLODID ()
 Get the ID of the previously (during the last render) selected LOD index. More...
 
int GetPickLODID (void)
 Get the ID of the appropriate pick LOD index. More...
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
void GetVolumes (vtkPropCollection *) override
 
void SetSelectedPickLODID (int id)
 Set the id of the LOD that is to be used for picking when automatic LOD pick selection is turned off. More...
 
virtual int GetSelectedPickLODID ()
 
virtual void SetAutomaticPickLODSelection (vtkTypeBool)
 Turn on / off automatic selection of picking LOD. More...
 
virtual vtkTypeBool GetAutomaticPickLODSelection ()
 
virtual void AutomaticPickLODSelectionOn ()
 
virtual void AutomaticPickLODSelectionOff ()
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkLODProp3D. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Support the standard render methods. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *ren) override
 
int RenderVolumetricGeometry (vtkViewport *ren) override
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Does this prop have some translucent polygonal geometry? More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this actor. More...
 
void SetAllocatedRenderTime (double t, vtkViewport *vp) override
 Used by the culler / renderer to set the allocated render time for this prop. More...
 
void RestoreEstimatedRenderTime () override
 Used when the render process is aborted to restore the previous estimated render time. More...
 
void AddEstimatedRenderTime (double t, vtkViewport *vp) override
 Override method from vtkProp in order to push this call down to the selected LOD as well. More...
 
- Public Member Functions inherited from vtkProp3D
vtkProp3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp3D. More...
 
virtual void SetPosition (double x, double y, double z)
 Set/Get/Add the position of the Prop3D in world coordinates. More...
 
virtual void SetPosition (double pos[3])
 
virtual double * GetPosition ()
 
virtual void GetPosition (double data[3])
 
void AddPosition (double deltaPosition[3])
 
void AddPosition (double deltaX, double deltaY, double deltaZ)
 
virtual void SetOrigin (double x, double y, double z)
 Set/Get the origin of the Prop3D. More...
 
virtual void SetOrigin (const double pos[3])
 
virtual double * GetOrigin ()
 
virtual void GetOrigin (double data[3])
 
virtual void SetScale (double x, double y, double z)
 Set/Get the scale of the actor. More...
 
virtual void SetScale (double scale[3])
 
virtual double * GetScale ()
 
virtual void GetScale (double data[3])
 
void SetScale (double s)
 Method to set the scale isotropically. More...
 
void SetUserTransform (vtkLinearTransform *transform)
 In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. More...
 
virtual vtkLinearTransformGetUserTransform ()
 
void SetUserMatrix (vtkMatrix4x4 *matrix)
 The UserMatrix can be used in place of UserTransform. More...
 
vtkMatrix4x4GetUserMatrix ()
 
virtual void GetMatrix (vtkMatrix4x4 *m)
 Return a reference to the Prop3D's 4x4 composite matrix. More...
 
virtual void GetMatrix (double m[16])
 
void GetBounds (double bounds[6])
 Return a reference to the Prop3D's composite transform. More...
 
double * GetCenter ()
 Get the center of the bounding box in world coordinates. More...
 
double * GetXRange ()
 Get the Prop3D's x range in world coordinates. More...
 
double * GetYRange ()
 Get the Prop3D's y range in world coordinates. More...
 
double * GetZRange ()
 Get the Prop3D's z range in world coordinates. More...
 
double GetLength ()
 Get the length of the diagonal of the bounding box. More...
 
void RotateX (double)
 Rotate the Prop3D in degrees about the X axis using the right hand rule. More...
 
void RotateY (double)
 Rotate the Prop3D in degrees about the Y axis using the right hand rule. More...
 
void RotateZ (double)
 Rotate the Prop3D in degrees about the Z axis using the right hand rule. More...
 
void RotateWXYZ (double w, double x, double y, double z)
 Rotate the Prop3D in degrees about an arbitrary axis specified by the last three arguments. More...
 
void SetOrientation (double x, double y, double z)
 Sets the orientation of the Prop3D. More...
 
void SetOrientation (double orientation[3])
 Sets the orientation of the Prop3D. More...
 
double * GetOrientation ()
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. More...
 
void GetOrientation (double orentation[3])
 
double * GetOrientationWXYZ ()
 Returns the WXYZ orientation of the Prop3D. More...
 
void AddOrientation (double x, double y, double z)
 Add to the current orientation. More...
 
void AddOrientation (double orentation[3])
 Add to the current orientation. More...
 
void PokeMatrix (vtkMatrix4x4 *matrix) override
 This method modifies the vtkProp3D so that its transformation state is set to the matrix specified. More...
 
void InitPathTraversal () override
 Overload vtkProp's method for setting up assembly paths. More...
 
vtkMTimeType GetMTime () override
 Get the vtkProp3D's mtime. More...
 
vtkMTimeType GetUserTransformMatrixMTime ()
 Get the modified time of the user matrix or user transform. More...
 
virtual void ComputeMatrix ()
 Generate the matrix based on ivars. More...
 
vtkMatrix4x4GetMatrix () override
 Get a pointer to an internal vtkMatrix4x4. More...
 
virtual int GetIsIdentity ()
 Is the matrix for this actor identity. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 
virtual void VisibilityOn ()
 
virtual void VisibilityOff ()
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 
virtual void PickableOn ()
 
virtual void PickableOff ()
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 
virtual void DragableOn ()
 
virtual void DragableOff ()
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
virtual void SetUseBounds (bool)
 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(). More...
 
virtual bool GetUseBounds ()
 
virtual void UseBoundsOn ()
 
virtual void UseBoundsOff ()
 
virtual vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderOverlay (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
virtual vtkTypeBool HasOpaqueGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry. More...
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 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. More...
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 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. More...
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 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. More...
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 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. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
void SetRenderTimeMultiplier (double t)
 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. More...
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 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. More...
 
virtual bool GetSupportsSelection ()
 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. More...
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkLODProp3DNew ()
 Create an instance of this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLODProp3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp3D
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkProp3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkLODProp3D ()
 
 ~vtkLODProp3D () override
 
int GetAutomaticPickPropIndex (void)
 
void UpdateKeysForSelectedProp ()
 
int GetNextEntryIndex ()
 
int ConvertIDToIndex (int id)
 
- Protected Member Functions inherited from vtkProp3D
 vtkProp3D ()
 
 ~vtkProp3D () override
 
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 
 ~vtkProp () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkLODProp3DEntryLODs
 
int NumberOfEntries
 
int NumberOfLODs
 
int CurrentIndex
 
int SelectedLODIndex
 
vtkTypeBool AutomaticLODSelection
 
int SelectedLODID
 
int SelectedPickLODID
 
vtkTypeBool AutomaticPickLODSelection
 
vtkLODProp3DCallback * PickCallback
 
- Protected Attributes inherited from vtkProp3D
vtkLinearTransformUserTransform
 
vtkMatrix4x4UserMatrix
 
vtkMatrix4x4Matrix
 
vtkTimeStamp MatrixMTime
 
double Origin [3]
 
double Position [3]
 
double Orientation [3]
 
double Scale [3]
 
double Center [3]
 
vtkTransformTransform
 
double Bounds [6]
 
vtkProp3DCachedProp3D
 
int IsIdentity
 
- Protected Attributes inherited from vtkProp
vtkTypeBool Visibility
 
vtkTypeBool Pickable
 
vtkTypeBool Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

level of detail 3D prop

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

Definition at line 57 of file vtkLODProp3D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 65 of file vtkLODProp3D.h.

Constructor & Destructor Documentation

◆ vtkLODProp3D()

vtkLODProp3D::vtkLODProp3D ( )
protected

◆ ~vtkLODProp3D()

vtkLODProp3D::~vtkLODProp3D ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkLODProp3D* vtkLODProp3D::New ( )
static

Create an instance of this class.

◆ IsTypeOf()

static vtkTypeBool vtkLODProp3D::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkLODProp3D::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkProp3D.

◆ SafeDownCast()

static vtkLODProp3D* vtkLODProp3D::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLODProp3D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkProp3D.

◆ NewInstance()

vtkLODProp3D* vtkLODProp3D::NewInstance ( ) const

◆ PrintSelf()

void vtkLODProp3D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ GetBounds() [1/2]

double* vtkLODProp3D::GetBounds ( )
overridevirtual

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

Implements vtkProp3D.

◆ GetBounds() [2/2]

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

Definition at line 72 of file vtkLODProp3D.h.

◆ AddLOD() [1/10]

int vtkLODProp3D::AddLOD ( vtkMapper m,
vtkProperty p,
vtkProperty back,
vtkTexture t,
double  time 
)

Add a level of detail with a given mapper, property, backface 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.

◆ AddLOD() [2/10]

int vtkLODProp3D::AddLOD ( vtkMapper m,
vtkProperty p,
vtkTexture t,
double  time 
)

◆ AddLOD() [3/10]

int vtkLODProp3D::AddLOD ( vtkMapper m,
vtkProperty p,
vtkProperty back,
double  time 
)

◆ AddLOD() [4/10]

int vtkLODProp3D::AddLOD ( vtkMapper m,
vtkProperty p,
double  time 
)

◆ AddLOD() [5/10]

int vtkLODProp3D::AddLOD ( vtkMapper m,
vtkTexture t,
double  time 
)

◆ AddLOD() [6/10]

int vtkLODProp3D::AddLOD ( vtkMapper m,
double  time 
)

◆ AddLOD() [7/10]

int vtkLODProp3D::AddLOD ( vtkAbstractVolumeMapper m,
vtkVolumeProperty p,
double  time 
)

◆ AddLOD() [8/10]

int vtkLODProp3D::AddLOD ( vtkAbstractVolumeMapper m,
double  time 
)

◆ AddLOD() [9/10]

int vtkLODProp3D::AddLOD ( vtkImageMapper3D m,
vtkImageProperty p,
double  time 
)

◆ AddLOD() [10/10]

int vtkLODProp3D::AddLOD ( vtkImageMapper3D m,
double  time 
)

◆ GetNumberOfLODs()

virtual int vtkLODProp3D::GetNumberOfLODs ( )
virtual

Get the current number of LODs.

◆ GetCurrentIndex()

virtual int vtkLODProp3D::GetCurrentIndex ( )
virtual

Get the current index, used to determine the ID of the next LOD that is added.

Useful for guessing what IDs have been used (with NumberOfLODs, without depending on the constructor initialization to 1000.

◆ RemoveLOD()

void vtkLODProp3D::RemoveLOD ( int  id)

Delete a level of detail given an ID.

This is the ID returned by the AddLOD method

◆ SetLODProperty() [1/3]

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.

◆ GetLODProperty() [1/3]

void vtkLODProp3D::GetLODProperty ( int  id,
vtkProperty **  p 
)

◆ SetLODProperty() [2/3]

void vtkLODProp3D::SetLODProperty ( int  id,
vtkVolumeProperty p 
)

◆ GetLODProperty() [2/3]

void vtkLODProp3D::GetLODProperty ( int  id,
vtkVolumeProperty **  p 
)

◆ SetLODProperty() [3/3]

void vtkLODProp3D::SetLODProperty ( int  id,
vtkImageProperty p 
)

◆ GetLODProperty() [3/3]

void vtkLODProp3D::GetLODProperty ( int  id,
vtkImageProperty **  p 
)

◆ SetLODMapper() [1/3]

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.

◆ GetLODMapper() [1/4]

void vtkLODProp3D::GetLODMapper ( int  id,
vtkMapper **  m 
)

◆ SetLODMapper() [2/3]

void vtkLODProp3D::SetLODMapper ( int  id,
vtkAbstractVolumeMapper m 
)

◆ GetLODMapper() [2/4]

void vtkLODProp3D::GetLODMapper ( int  id,
vtkAbstractVolumeMapper **  m 
)

◆ SetLODMapper() [3/3]

void vtkLODProp3D::SetLODMapper ( int  id,
vtkImageMapper3D m 
)

◆ GetLODMapper() [3/4]

void vtkLODProp3D::GetLODMapper ( int  id,
vtkImageMapper3D **  m 
)

◆ GetLODMapper() [4/4]

vtkAbstractMapper3D* vtkLODProp3D::GetLODMapper ( int  id)

Get the LODMapper as an vtkAbstractMapper3D.

It is the user's respondibility to safe down cast this to a vtkMapper or vtkVolumeMapper as appropriate.

◆ SetLODBackfaceProperty()

void vtkLODProp3D::SetLODBackfaceProperty ( int  id,
vtkProperty t 
)

Methods to set / get the backface property of an LOD.

This method is only valid for LOD ids that are Actors (not Volumes)

◆ GetLODBackfaceProperty()

void vtkLODProp3D::GetLODBackfaceProperty ( int  id,
vtkProperty **  t 
)

◆ SetLODTexture()

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)

◆ GetLODTexture()

void vtkLODProp3D::GetLODTexture ( int  id,
vtkTexture **  t 
)

◆ EnableLOD()

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.

◆ DisableLOD()

void vtkLODProp3D::DisableLOD ( int  id)

◆ IsLODEnabled()

int vtkLODProp3D::IsLODEnabled ( int  id)

◆ SetLODLevel()

void vtkLODProp3D::SetLODLevel ( int  id,
double  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 double to ensure that a level can be inserted between 2 and 3.

◆ GetLODLevel()

double vtkLODProp3D::GetLODLevel ( int  id)

◆ GetLODIndexLevel()

double vtkLODProp3D::GetLODIndexLevel ( int  index)

◆ GetLODEstimatedRenderTime()

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

◆ GetLODIndexEstimatedRenderTime()

double vtkLODProp3D::GetLODIndexEstimatedRenderTime ( int  index)

◆ SetAutomaticLODSelection()

virtual void vtkLODProp3D::SetAutomaticLODSelection ( vtkTypeBool  )
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.

◆ GetAutomaticLODSelection()

virtual vtkTypeBool vtkLODProp3D::GetAutomaticLODSelection ( )
virtual

◆ AutomaticLODSelectionOn()

virtual void vtkLODProp3D::AutomaticLODSelectionOn ( )
virtual

◆ AutomaticLODSelectionOff()

virtual void vtkLODProp3D::AutomaticLODSelectionOff ( )
virtual

◆ SetSelectedLODID()

virtual void vtkLODProp3D::SetSelectedLODID ( int  )
virtual

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

◆ GetSelectedLODID()

virtual int vtkLODProp3D::GetSelectedLODID ( )
virtual

◆ GetLastRenderedLODID()

int vtkLODProp3D::GetLastRenderedLODID ( )

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

◆ GetPickLODID()

int vtkLODProp3D::GetPickLODID ( void  )

Get the ID of the appropriate pick LOD index.

◆ GetActors()

void vtkLODProp3D::GetActors ( vtkPropCollection )
overridevirtual

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.

◆ GetVolumes()

void vtkLODProp3D::GetVolumes ( vtkPropCollection )
overridevirtual

Reimplemented from vtkProp.

◆ SetSelectedPickLODID()

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.

◆ GetSelectedPickLODID()

virtual int vtkLODProp3D::GetSelectedPickLODID ( )
virtual

◆ SetAutomaticPickLODSelection()

virtual void vtkLODProp3D::SetAutomaticPickLODSelection ( vtkTypeBool  )
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.

◆ GetAutomaticPickLODSelection()

virtual vtkTypeBool vtkLODProp3D::GetAutomaticPickLODSelection ( )
virtual

◆ AutomaticPickLODSelectionOn()

virtual void vtkLODProp3D::AutomaticPickLODSelectionOn ( )
virtual

◆ AutomaticPickLODSelectionOff()

virtual void vtkLODProp3D::AutomaticPickLODSelectionOff ( )
virtual

◆ ShallowCopy()

void vtkLODProp3D::ShallowCopy ( vtkProp prop)
overridevirtual

Shallow copy of this vtkLODProp3D.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkLODProp3D::RenderOpaqueGeometry ( vtkViewport viewport)
overridevirtual

Support the standard render methods.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkLODProp3D::RenderTranslucentPolygonalGeometry ( vtkViewport ren)
overridevirtual

Reimplemented from vtkProp.

◆ RenderVolumetricGeometry()

int vtkLODProp3D::RenderVolumetricGeometry ( vtkViewport ren)
overridevirtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkLODProp3D::HasTranslucentPolygonalGeometry ( )
overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkLODProp3D::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

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.

◆ SetAllocatedRenderTime()

void vtkLODProp3D::SetAllocatedRenderTime ( double  t,
vtkViewport vp 
)
override

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.

◆ RestoreEstimatedRenderTime()

void vtkLODProp3D::RestoreEstimatedRenderTime ( )
overridevirtual

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.

◆ AddEstimatedRenderTime()

void vtkLODProp3D::AddEstimatedRenderTime ( double  t,
vtkViewport vp 
)
override

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

◆ GetAutomaticPickPropIndex()

int vtkLODProp3D::GetAutomaticPickPropIndex ( void  )
protected

◆ UpdateKeysForSelectedProp()

void vtkLODProp3D::UpdateKeysForSelectedProp ( )
protected

◆ GetNextEntryIndex()

int vtkLODProp3D::GetNextEntryIndex ( )
protected

◆ ConvertIDToIndex()

int vtkLODProp3D::ConvertIDToIndex ( int  id)
protected

Member Data Documentation

◆ LODs

vtkLODProp3DEntry* vtkLODProp3D::LODs
protected

Definition at line 324 of file vtkLODProp3D.h.

◆ NumberOfEntries

int vtkLODProp3D::NumberOfEntries
protected

Definition at line 325 of file vtkLODProp3D.h.

◆ NumberOfLODs

int vtkLODProp3D::NumberOfLODs
protected

Definition at line 326 of file vtkLODProp3D.h.

◆ CurrentIndex

int vtkLODProp3D::CurrentIndex
protected

Definition at line 327 of file vtkLODProp3D.h.

◆ SelectedLODIndex

int vtkLODProp3D::SelectedLODIndex
protected

Definition at line 331 of file vtkLODProp3D.h.

◆ AutomaticLODSelection

vtkTypeBool vtkLODProp3D::AutomaticLODSelection
protected

Definition at line 333 of file vtkLODProp3D.h.

◆ SelectedLODID

int vtkLODProp3D::SelectedLODID
protected

Definition at line 334 of file vtkLODProp3D.h.

◆ SelectedPickLODID

int vtkLODProp3D::SelectedPickLODID
protected

Definition at line 335 of file vtkLODProp3D.h.

◆ AutomaticPickLODSelection

vtkTypeBool vtkLODProp3D::AutomaticPickLODSelection
protected

Definition at line 336 of file vtkLODProp3D.h.

◆ PickCallback

vtkLODProp3DCallback* vtkLODProp3D::PickCallback
protected

Definition at line 337 of file vtkLODProp3D.h.


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