vtkOverrideAttribute Class Reference

Attribute for vtkObjectFactory overrides. More...

#include <vtkOverrideAttribute.h>

Inheritance diagram for vtkOverrideAttribute:

Collaboration diagram for vtkOverrideAttribute:

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.
vtkOverrideAttribute *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
	vtkGetCharFromStdStringMacro (Name)
	Get the name of the attribute.
	vtkGetCharFromStdStringMacro (Value)
	Get the value of the attribute.
virtual vtkOverrideAttribute *	GetNext ()
	Get the next attribute in the linked list.
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	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.
vtkCommand *	GetCommand (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 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 vtkOverrideAttribute *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOverrideAttribute *	SafeDownCast (vtkObjectBase *o)
static vtkOverrideAttribute *	CreateAttributeChain (const char *name, const char *value, vtkOverrideAttribute *nextInChain)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const
	vtkOverrideAttribute ()
	~vtkOverrideAttribute () 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	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
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

Detailed Description

Attribute for vtkObjectFactory overrides.

vtkOverrideAttribute represents a key/value pair attribute associated with an override class. Attributes are organized as a linked list and used to select the best override based on user preferences.

Usage:

Use the static CreateAttributeChain() method to create a linked list of attributes. For example:

vtkOverrideAttribute* vtkMyOverrideClass::CreateOverrideAttributes()
{
  auto* platformAttribute =
    vtkOverrideAttribute::CreateAttributeChain("Platform", "iOS", nullptr);
  auto* windowSystemAttribute =
    vtkOverrideAttribute::CreateAttributeChain("WindowSystem", "Cocoa", platformAttribute);
  auto* renderingAttribute =
    vtkOverrideAttribute::CreateAttributeChain("RenderingBackend", "OpenGL",
     windowSystemAttribute);
  return renderingAttribute;
}

Requirements:

Override classes must define a vtkClassName_OVERRIDE_ATTRIBUTES macro:

#define vtkClassName_OVERRIDE_ATTRIBUTES vtkClassName::CreateOverrideAttributes()

See also

vtkObjectFactory

Tests:

vtkOverrideAttribute (Tests)

Definition at line 50 of file vtkOverrideAttribute.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkOverrideAttribute::Superclass

Definition at line 54 of file vtkOverrideAttribute.h.

Constructor & Destructor Documentation

vtkOverrideAttribute()

vtkOverrideAttribute::vtkOverrideAttribute ( )

protected

~vtkOverrideAttribute()

vtkOverrideAttribute::~vtkOverrideAttribute ( )

overrideprotected

Member Function Documentation

New()

static vtkOverrideAttribute * vtkOverrideAttribute::New ( )

static

IsTypeOf()

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

static

IsA()

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

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkOverrideAttribute::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkOverrideAttribute * vtkOverrideAttribute::NewInstance

(

)

const

PrintSelf()

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

vtkGetCharFromStdStringMacro() [1/2]

vtkOverrideAttribute::vtkGetCharFromStdStringMacro

(

Name

)

Get the name of the attribute.

vtkGetCharFromStdStringMacro() [2/2]

vtkOverrideAttribute::vtkGetCharFromStdStringMacro

(

Value

)

Get the value of the attribute.

GetNext()

virtual vtkOverrideAttribute * vtkOverrideAttribute::GetNext ( )

virtual

Get the next attribute in the linked list.

CreateAttributeChain()

static vtkOverrideAttribute * vtkOverrideAttribute::CreateAttributeChain ( const char * name, const char * value, vtkOverrideAttribute * nextInChain )

static

---

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

• Common/Core/vtkOverrideAttribute.h