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

Implement model-view-projection transforms in the OpenGL renderer. More...

#include <vtkGLSLModCamera.h>

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

Public Types

typedef vtkGLSLModifierBase Superclass
 
- Public Types inherited from vtkGLSLModifierBase
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.
 
vtkGLSLModCameraNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void EnableShiftScale (bool coordShiftAndScaleInUse, vtkMatrix4x4 *ssMatrix)
 
void DisableShiftScale ()
 
bool ReplaceShaderValues (vtkOpenGLRenderer *renderer, std::string &vertexShader, std::string &tessControlShader, std::string &tessEvalShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkActor *actor) override
 Abstract interfaces to replace shader values and apply parameters as uniform values.
 
bool SetShaderParameters (vtkOpenGLRenderer *renderer, vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkActor *actor, vtkOpenGLVertexArrayObject *VAO=nullptr) override
 
bool IsUpToDate (vtkOpenGLRenderer *vtkNotUsed(renderer), vtkAbstractMapper *vtkNotUsed(mapper), vtkActor *vtkNotUsed(actor)) override
 
- Public Member Functions inherited from vtkGLSLModifierBase
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkGLSLModifierBaseNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void SetPrimitiveType (unsigned int primType)
 The renderer will set primitive type.
 
virtual bool ReplaceShaderValues (vtkOpenGLRenderer *renderer, std::string &vertexShader, std::string &tessControlShader, std::string &tessEvalShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkActor *actor)=0
 Abstract interfaces to replace shader values and apply parameters as uniform values.
 
virtual bool SetShaderParameters (vtkOpenGLRenderer *renderer, vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkActor *actor, vtkOpenGLVertexArrayObject *VAO=nullptr)=0
 
virtual bool IsUpToDate (vtkOpenGLRenderer *renderer, vtkAbstractMapper *mapper, vtkActor *actor)=0
 Whether mod needs to be re-applied.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkGLSLModCameraNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGLSLModCameraSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGLSLModifierBase
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGLSLModifierBaseSafeDownCast (vtkObjectBase *o)
 
static vtkInformationObjectBaseKeyGLSL_MODIFIERS ()
 if this key exists on the ShaderMods of vtkDrawTexturedElements, that mod will be applied before rendering.
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGLSLModCamera ()
 
 ~vtkGLSLModCamera () override
 
- Protected Member Functions inherited from vtkGLSLModifierBase
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGLSLModifierBase ()
 
 ~vtkGLSLModifierBase () 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkNew< vtkMatrix3x3TempMatrix3
 
vtkNew< vtkMatrix4x4TempMatrix4
 
bool CoordinateShiftAndScaleInUse
 
bool ApplyShiftAndScaleFromShader
 
vtkSmartPointer< vtkMatrix4x4SSMatrix
 
- Protected Attributes inherited from vtkGLSLModifierBase
unsigned int PrimitiveType = 0
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Implement model-view-projection transforms in the OpenGL renderer.

Tests:
vtkGLSLModCamera (Tests)

Definition at line 27 of file vtkGLSLModCamera.h.

Member Typedef Documentation

◆ Superclass

Definition at line 31 of file vtkGLSLModCamera.h.

Constructor & Destructor Documentation

◆ vtkGLSLModCamera()

vtkGLSLModCamera::vtkGLSLModCamera ( )
protected

◆ ~vtkGLSLModCamera()

vtkGLSLModCamera::~vtkGLSLModCamera ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGLSLModCamera * vtkGLSLModCamera::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkGLSLModCamera::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 vtkGLSLModifierBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGLSLModCamera::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkGLSLModifierBase.

◆ NewInstance()

vtkGLSLModCamera * vtkGLSLModCamera::NewInstance ( ) const

◆ PrintSelf()

void vtkGLSLModCamera::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 vtkObjectBase.

◆ EnableShiftScale()

void vtkGLSLModCamera::EnableShiftScale ( bool  coordShiftAndScaleInUse,
vtkMatrix4x4 ssMatrix 
)

◆ DisableShiftScale()

void vtkGLSLModCamera::DisableShiftScale ( )

◆ ReplaceShaderValues()

bool vtkGLSLModCamera::ReplaceShaderValues ( vtkOpenGLRenderer renderer,
std::string &  vertexShader,
std::string &  tessControlShader,
std::string &  tessEvalShader,
std::string &  geometryShader,
std::string &  fragmentShader,
vtkAbstractMapper mapper,
vtkActor actor 
)
overridevirtual

Abstract interfaces to replace shader values and apply parameters as uniform values.

Implements vtkGLSLModifierBase.

◆ SetShaderParameters()

bool vtkGLSLModCamera::SetShaderParameters ( vtkOpenGLRenderer renderer,
vtkShaderProgram program,
vtkAbstractMapper mapper,
vtkActor actor,
vtkOpenGLVertexArrayObject VAO = nullptr 
)
overridevirtual

Implements vtkGLSLModifierBase.

◆ IsUpToDate()

bool vtkGLSLModCamera::IsUpToDate ( vtkOpenGLRenderer vtkNotUsedrenderer,
vtkAbstractMapper vtkNotUsedmapper,
vtkActor vtkNotUsedactor 
)
inlineoverride

Definition at line 44 of file vtkGLSLModCamera.h.

Member Data Documentation

◆ TempMatrix3

vtkNew<vtkMatrix3x3> vtkGLSLModCamera::TempMatrix3
protected

Definition at line 56 of file vtkGLSLModCamera.h.

◆ TempMatrix4

vtkNew<vtkMatrix4x4> vtkGLSLModCamera::TempMatrix4
protected

Definition at line 57 of file vtkGLSLModCamera.h.

◆ CoordinateShiftAndScaleInUse

bool vtkGLSLModCamera::CoordinateShiftAndScaleInUse
protected

Definition at line 59 of file vtkGLSLModCamera.h.

◆ ApplyShiftAndScaleFromShader

bool vtkGLSLModCamera::ApplyShiftAndScaleFromShader
protected

Definition at line 60 of file vtkGLSLModCamera.h.

◆ SSMatrix

vtkSmartPointer<vtkMatrix4x4> vtkGLSLModCamera::SSMatrix
protected

Definition at line 61 of file vtkGLSLModCamera.h.


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