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

Widget representation for WebGL. More...

#include <vtkWebGLWidget.h>

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

Public Types

typedef vtkWebGLObject Superclass
 
- Public Types inherited from vtkWebGLObject
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...
 
vtkWebGLWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void GenerateBinaryData () override
 
unsigned char * GetBinaryData (int part) override
 
int GetBinarySize (int part) override
 
int GetNumberOfParts () override
 
void GetDataFromColorMap (vtkActor2D *actor)
 
- Public Member Functions inherited from vtkWebGLObject
vtkWebGLObjectNewInstance () const
 
void GetBinaryData (int part, vtkUnsignedCharArray *buffer)
 This is a wrapper friendly method for access the binary data. More...
 
void SetLayer (int l)
 
void SetRendererId (size_t i)
 
void SetId (const std::string &i)
 
void SetWireframeMode (bool wireframe)
 
void SetVisibility (bool vis)
 
void SetTransformationMatrix (vtkMatrix4x4 *m)
 
void SetIsWidget (bool w)
 
void SetHasTransparency (bool t)
 
void SetInteractAtServer (bool i)
 
void SetType (WebGLObjectTypes t)
 
bool isWireframeMode ()
 
bool isVisible ()
 
bool HasChanged ()
 
bool isWidget ()
 
bool HasTransparency ()
 
bool InteractAtServer ()
 
std::string GetMD5 ()
 
std::string GetId ()
 
size_t GetRendererId ()
 
int GetLayer ()
 
- 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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...
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkWebGLWidgetNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWebGLWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWebGLObject
static vtkWebGLObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWebGLObjectSafeDownCast (vtkObjectBase *o)
 
- 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 (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWebGLWidget ()
 
 ~vtkWebGLWidget () override
 
- Protected Member Functions inherited from vtkWebGLObject
 vtkWebGLObject ()
 
 ~vtkWebGLObject () 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

unsigned char * binaryData
 
int binarySize
 
int orientation
 
char * title
 
char * textFormat
 
int textPosition
 
float position [2]
 
float size [2]
 
int numberOfLabels
 
std::vector< double * > colors
 
- Protected Attributes inherited from vtkWebGLObject
float Matrix [16]
 
size_t rendererId
 
int layer
 
std::string id
 
std::string MD5
 
bool hasChanged
 
bool iswireframeMode
 
bool isvisible
 
WebGLObjectTypes webGlType
 
bool hasTransparency
 
bool iswidget
 
bool interactAtServer
 
- 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

Widget representation for WebGL.

Definition at line 19 of file vtkWebGLWidget.h.

Member Typedef Documentation

◆ Superclass

Definition at line 23 of file vtkWebGLWidget.h.

Constructor & Destructor Documentation

◆ vtkWebGLWidget()

vtkWebGLWidget::vtkWebGLWidget ( )
protected

◆ ~vtkWebGLWidget()

vtkWebGLWidget::~vtkWebGLWidget ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkWebGLWidget* vtkWebGLWidget::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkWebGLWidget::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 vtkWebGLObject.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWebGLWidget::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWebGLObject.

◆ NewInstance()

vtkWebGLWidget* vtkWebGLWidget::NewInstance ( ) const

◆ PrintSelf()

void vtkWebGLWidget::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 vtkWebGLObject.

◆ GenerateBinaryData()

void vtkWebGLWidget::GenerateBinaryData ( )
overridevirtual

Reimplemented from vtkWebGLObject.

◆ GetBinaryData()

unsigned char* vtkWebGLWidget::GetBinaryData ( int  part)
overridevirtual

Reimplemented from vtkWebGLObject.

◆ GetBinarySize()

int vtkWebGLWidget::GetBinarySize ( int  part)
overridevirtual

Reimplemented from vtkWebGLObject.

◆ GetNumberOfParts()

int vtkWebGLWidget::GetNumberOfParts ( )
overridevirtual

Reimplemented from vtkWebGLObject.

◆ GetDataFromColorMap()

void vtkWebGLWidget::GetDataFromColorMap ( vtkActor2D actor)

Member Data Documentation

◆ binaryData

unsigned char* vtkWebGLWidget::binaryData
protected

Definition at line 37 of file vtkWebGLWidget.h.

◆ binarySize

int vtkWebGLWidget::binarySize
protected

Definition at line 38 of file vtkWebGLWidget.h.

◆ orientation

int vtkWebGLWidget::orientation
protected

Definition at line 39 of file vtkWebGLWidget.h.

◆ title

char* vtkWebGLWidget::title
protected

Definition at line 40 of file vtkWebGLWidget.h.

◆ textFormat

char* vtkWebGLWidget::textFormat
protected

Definition at line 41 of file vtkWebGLWidget.h.

◆ textPosition

int vtkWebGLWidget::textPosition
protected

Definition at line 42 of file vtkWebGLWidget.h.

◆ position

float vtkWebGLWidget::position[2]
protected

Definition at line 43 of file vtkWebGLWidget.h.

◆ size

float vtkWebGLWidget::size[2]
protected

Definition at line 44 of file vtkWebGLWidget.h.

◆ numberOfLabels

int vtkWebGLWidget::numberOfLabels
protected

Definition at line 45 of file vtkWebGLWidget.h.

◆ colors

std::vector<double*> vtkWebGLWidget::colors
protected

Definition at line 46 of file vtkWebGLWidget.h.


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