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

vtkWebGLObject represent and manipulate an WebGL object and its data. More...

#include <vtkWebGLObject.h>

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

Public Types

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...
 
vtkWebGLObjectNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void GenerateBinaryData ()
 
virtual unsigned char * GetBinaryData (int part)
 
virtual int GetBinarySize (int part)
 
virtual int GetNumberOfParts ()
 
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 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
 
 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

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

vtkWebGLObject represent and manipulate an WebGL object and its data.

Definition at line 27 of file vtkWebGLObject.h.

Member Typedef Documentation

◆ Superclass

Definition at line 31 of file vtkWebGLObject.h.

Constructor & Destructor Documentation

◆ vtkWebGLObject()

vtkWebGLObject::vtkWebGLObject ( )
protected

◆ ~vtkWebGLObject()

vtkWebGLObject::~vtkWebGLObject ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkWebGLObject* vtkWebGLObject::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkWebGLWidget, and vtkWebGLPolyData.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWebGLObject::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkWebGLWidget, and vtkWebGLPolyData.

◆ NewInstance()

vtkWebGLObject* vtkWebGLObject::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkWebGLWidget, and vtkWebGLPolyData.

◆ GenerateBinaryData()

virtual void vtkWebGLObject::GenerateBinaryData ( )
virtual

Reimplemented in vtkWebGLWidget, and vtkWebGLPolyData.

◆ GetBinaryData() [1/2]

virtual unsigned char* vtkWebGLObject::GetBinaryData ( int  part)
virtual

Reimplemented in vtkWebGLWidget, and vtkWebGLPolyData.

◆ GetBinarySize()

virtual int vtkWebGLObject::GetBinarySize ( int  part)
virtual

Reimplemented in vtkWebGLWidget, and vtkWebGLPolyData.

◆ GetNumberOfParts()

virtual int vtkWebGLObject::GetNumberOfParts ( )
virtual

Reimplemented in vtkWebGLWidget, and vtkWebGLPolyData.

◆ GetBinaryData() [2/2]

void vtkWebGLObject::GetBinaryData ( int  part,
vtkUnsignedCharArray buffer 
)

This is a wrapper friendly method for access the binary data.

The binary data for the requested part will be copied into the given vtkUnsignedCharArray.

◆ SetLayer()

void vtkWebGLObject::SetLayer ( int  l)

◆ SetRendererId()

void vtkWebGLObject::SetRendererId ( size_t  i)

◆ SetId()

void vtkWebGLObject::SetId ( const std::string &  i)

◆ SetWireframeMode()

void vtkWebGLObject::SetWireframeMode ( bool  wireframe)

◆ SetVisibility()

void vtkWebGLObject::SetVisibility ( bool  vis)

◆ SetTransformationMatrix()

void vtkWebGLObject::SetTransformationMatrix ( vtkMatrix4x4 m)

◆ SetIsWidget()

void vtkWebGLObject::SetIsWidget ( bool  w)

◆ SetHasTransparency()

void vtkWebGLObject::SetHasTransparency ( bool  t)

◆ SetInteractAtServer()

void vtkWebGLObject::SetInteractAtServer ( bool  i)

◆ SetType()

void vtkWebGLObject::SetType ( WebGLObjectTypes  t)

◆ isWireframeMode()

bool vtkWebGLObject::isWireframeMode ( )

◆ isVisible()

bool vtkWebGLObject::isVisible ( )

◆ HasChanged()

bool vtkWebGLObject::HasChanged ( )

◆ isWidget()

bool vtkWebGLObject::isWidget ( )

◆ HasTransparency()

bool vtkWebGLObject::HasTransparency ( )

◆ InteractAtServer()

bool vtkWebGLObject::InteractAtServer ( )

◆ GetMD5()

std::string vtkWebGLObject::GetMD5 ( )

◆ GetId()

std::string vtkWebGLObject::GetId ( )

◆ GetRendererId()

size_t vtkWebGLObject::GetRendererId ( )

◆ GetLayer()

int vtkWebGLObject::GetLayer ( )

Member Data Documentation

◆ Matrix

float vtkWebGLObject::Matrix[16]
protected

Definition at line 73 of file vtkWebGLObject.h.

◆ rendererId

size_t vtkWebGLObject::rendererId
protected

Definition at line 74 of file vtkWebGLObject.h.

◆ layer

int vtkWebGLObject::layer
protected

Definition at line 75 of file vtkWebGLObject.h.

◆ id

std::string vtkWebGLObject::id
protected

Definition at line 76 of file vtkWebGLObject.h.

◆ MD5

std::string vtkWebGLObject::MD5
protected

Definition at line 77 of file vtkWebGLObject.h.

◆ hasChanged

bool vtkWebGLObject::hasChanged
protected

Definition at line 78 of file vtkWebGLObject.h.

◆ iswireframeMode

bool vtkWebGLObject::iswireframeMode
protected

Definition at line 79 of file vtkWebGLObject.h.

◆ isvisible

bool vtkWebGLObject::isvisible
protected

Definition at line 80 of file vtkWebGLObject.h.

◆ webGlType

WebGLObjectTypes vtkWebGLObject::webGlType
protected

Definition at line 81 of file vtkWebGLObject.h.

◆ hasTransparency

bool vtkWebGLObject::hasTransparency
protected

Definition at line 82 of file vtkWebGLObject.h.

◆ iswidget

bool vtkWebGLObject::iswidget
protected

Definition at line 83 of file vtkWebGLObject.h.

◆ interactAtServer

bool vtkWebGLObject::interactAtServer
protected

Definition at line 84 of file vtkWebGLObject.h.


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