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

a list of Shader2 objects. More...

#include <vtkShader2Collection.h>

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

Public Types

typedef vtkCollection Superclass
 
- Public Types inherited from vtkCollection
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkShader2CollectionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkMTimeType GetMTime ()
 Modified GetMTime because the collection time depends on the content of the shaders. More...
 
void AddItem (vtkShader2 *shader)
 Add a shader to the list. More...
 
vtkShader2GetNextShader ()
 Get the next shader in the list. More...
 
vtkShader2GetLastShader ()
 Get the last shader in the list. More...
 
vtkShader2GetNextShader (vtkCollectionSimpleIterator &cookie)
 Reentrant safe way to get an object in a collection. More...
 
void AddCollection (vtkShader2Collection *other)
 Add the elements of `other' to the end of `this'. More...
 
void RemoveCollection (vtkShader2Collection *other)
 Remove the elements of `other' from `this'. More...
 
bool HasVertexShaders ()
 Tells if at least one of the shaders is a vertex shader. More...
 
bool HasTessellationControlShaders ()
 Tells if at least one of the shaders is a tessellation control shader. More...
 
bool HasTessellationEvaluationShaders ()
 Tells if at least one of the shaders is a tessellation evaluation shader. More...
 
bool HasGeometryShaders ()
 Tells if at least one of the shaders is a geometry shader. More...
 
bool HasFragmentShaders ()
 Tells if at least one of the shaders is a fragment shader. More...
 
void ReleaseGraphicsResources ()
 Release OpenGL resources (shader id of each item). More...
 
- Public Member Functions inherited from vtkCollection
vtkCollectionNewInstance () const
 
void AddItem (vtkObject *)
 Add an object to the list. More...
 
void InsertItem (int i, vtkObject *)
 Insert item into the list after the i'th item. More...
 
void ReplaceItem (int i, vtkObject *)
 Replace the i'th item in the collection with a. More...
 
void RemoveItem (int i)
 Remove the i'th item in the list. More...
 
void RemoveItem (vtkObject *)
 Remove an object from the list. More...
 
void RemoveAllItems ()
 Remove all objects from the list. More...
 
int IsItemPresent (vtkObject *a)
 Search for an object and return location in list. More...
 
int GetNumberOfItems ()
 Return the number of objects in the list. More...
 
void InitTraversal ()
 Initialize the traversal of the collection. More...
 
void InitTraversal (vtkCollectionSimpleIterator &cookie)
 A reentrant safe way to iterate through a collection. More...
 
vtkObjectGetNextItemAsObject ()
 Get the next item in the collection. More...
 
vtkObjectGetItemAsObject (int i)
 Get the i'th item in the collection. More...
 
vtkObjectGetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
 A reentrant safe way to get the next object as a collection. More...
 
VTK_NEWINSTANCE vtkCollectionIteratorNewIterator ()
 Get an iterator to traverse the objects in this collection. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
- 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...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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...
 
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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. 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...
 

Static Public Member Functions

static vtkShader2CollectionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkShader2CollectionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCollection
static int IsTypeOf (const char *type)
 
static vtkCollectionSafeDownCast (vtkObjectBase *o)
 
static vtkCollectionNew ()
 Construct with empty list. 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 ()
 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 int 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkShader2Collection ()
 
 ~vtkShader2Collection ()
 
bool HasShadersOfType (int)
 
- Protected Member Functions inherited from vtkCollection
 vtkCollection ()
 
 ~vtkCollection () override
 
virtual void RemoveElement (vtkCollectionElement *element, vtkCollectionElement *previous)
 
virtual void DeleteElement (vtkCollectionElement *)
 
void ReportReferences (vtkGarbageCollector *collector) 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=NULL)
 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 CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkCollection
int NumberOfItems
 
vtkCollectionElementTop
 
vtkCollectionElementBottom
 
vtkCollectionElementCurrent
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a list of Shader2 objects.

vtkShader2Collection represents and provides methods to manipulate a list of Shader2 objects. The list is unsorted and duplicate entries are not prevented.

See also
vtkShader2 vtkCollection

Definition at line 35 of file vtkShader2Collection.h.

Member Typedef Documentation

Definition at line 39 of file vtkShader2Collection.h.

Constructor & Destructor Documentation

vtkShader2Collection::vtkShader2Collection ( )
protected
vtkShader2Collection::~vtkShader2Collection ( )
protected

Member Function Documentation

static vtkShader2Collection* vtkShader2Collection::New ( )
static
static int vtkShader2Collection::IsTypeOf ( const char *  type)
static
virtual int vtkShader2Collection::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 vtkCollection.

static vtkShader2Collection* vtkShader2Collection::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkShader2Collection::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCollection.

vtkShader2Collection* vtkShader2Collection::NewInstance ( ) const
void vtkShader2Collection::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 vtkCollection.

vtkMTimeType vtkShader2Collection::GetMTime ( )
virtual

Modified GetMTime because the collection time depends on the content of the shaders.

Reimplemented from vtkObject.

void vtkShader2Collection::AddItem ( vtkShader2 shader)

Add a shader to the list.

vtkShader2* vtkShader2Collection::GetNextShader ( )

Get the next shader in the list.

vtkShader2* vtkShader2Collection::GetLastShader ( )

Get the last shader in the list.

vtkShader2* vtkShader2Collection::GetNextShader ( vtkCollectionSimpleIterator cookie)

Reentrant safe way to get an object in a collection.

Just pass the same cookie back and forth.

void vtkShader2Collection::AddCollection ( vtkShader2Collection other)

Add the elements of `other' to the end of `this'.

Precondition
other_exists: other!=0
not_self: other!=this
Postcondition
added: this->GetNumberOfItems()=old this->GetNumberOfItems()+other->GetNumberOfItems()
void vtkShader2Collection::RemoveCollection ( vtkShader2Collection other)

Remove the elements of `other' from `this'.

It assumes that `this' already has all the elements of `other' added contiguously.

Precondition
other_exists: other!=0
not_self: other!=this
Postcondition
removed: this->GetNumberOfItems()=old this->GetNumberOfItems()-other->GetNumberOfItems()
bool vtkShader2Collection::HasVertexShaders ( )

Tells if at least one of the shaders is a vertex shader.

If yes, it means the vertex processing of the fixed-pipeline is bypassed. If no, it means the vertex processing of the fixed-pipeline is used.

bool vtkShader2Collection::HasTessellationControlShaders ( )

Tells if at least one of the shaders is a tessellation control shader.

bool vtkShader2Collection::HasTessellationEvaluationShaders ( )

Tells if at least one of the shaders is a tessellation evaluation shader.

bool vtkShader2Collection::HasGeometryShaders ( )

Tells if at least one of the shaders is a geometry shader.

bool vtkShader2Collection::HasFragmentShaders ( )

Tells if at least one of the shaders is a fragment shader.

If yes, it means the fragment processing of the fixed-pipeline is bypassed. If no, it means the fragment processing of the fixed-pipeline is used.

void vtkShader2Collection::ReleaseGraphicsResources ( )

Release OpenGL resources (shader id of each item).

bool vtkShader2Collection::HasShadersOfType ( int  )
protected

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