| GL Studio C++ Runtime API

Public Types | Public Member Functions | List of all members
DistiAttributeColorMaterialModeEnum< containerClass > Class Template Reference

`#include <gls_metadata_attributes.h>`

Inheritance diagram for DistiAttributeColorMaterialModeEnum< containerClass >:

## Public Types
typedef DistiAttributeEnum< containerClass, const int, int > | _BaseClass
| Deprecated typedef for the base class.
typedef DistiAttributeEnum< containerClass, const int, int > | BaseClass
| Typedef for the base class.
typedef void(containerClass::* | SetMethodType) (const int)
| Typedef for the set method function pointer.
typedef int(containerClass::* | GetMethodType) ()
| Typedef for the get method function pointer.
Public Types inherited from DistiAttributeEnum< containerClass, const int, int >
typedef void(containerClass::* | SetMethodType) (const int)
| Typedef for the set method function pointer.
typedef int(containerClass::* | GetMethodType) ()
| Typedef for the get method function pointer.
Public Types inherited from DistiAttributeBase
typedef unsigned int | CallbackID
| Type for unique identifiers.

## Public Member Functions
| DistiAttributeColorMaterialModeEnum (containerClass *frame, SetMethodType setMethod, GetMethodType getMethod, const AttributeName &name)
virtual bool | OkToWrite () const override
std::string | Type () const override
Public Member Functions inherited from DistiAttributeEnum< containerClass, const int, int >
| DistiAttributeEnum (containerClass *object, SetMethodType setMethod, GetMethodType getMethod, const AttributeName &name)
virtual long | ValueInt () override
virtual void | ValueInt (long val) override
virtual DistiAttributeBase & | operator= (const DistiAttributeBase &oldClass) override
virtual std::ostream & | WriteValue (std::ostream &outstr) override
int | EnumToInt (std::string &string)
virtual std::istream & | ReadValue (std::istream &instr) override
Public Member Functions inherited from DistiAttributeBase
| DistiAttributeBase (CallbackMethodCallerBase *callback, const AttributeName &name, bool localStorage)
virtual DistiAttributeBase & | operator= (const DistiAttributeBase &oldClass)
const AttributeName & | Name () const
AttributeName & | Name ()
bool | LocalStorage () const
virtual bool | Copyable () const
virtual bool | OkToWrite () const
virtual bool | ValueChanged ()
virtual void | ResetValueChanged ()
virtual std::string | ValueString ()
virtual void | ValueString (const std::string &s)
virtual long | ValueInt ()
virtual void | ValueInt (long val)
virtual double | ValueFloat ()
virtual void | ValueFloat (double val)
virtual void | CallCallback ()
| Calls callback CallType3 if it has been set.
virtual std::ostream & | WriteValue (std::ostream &outstr)=0
virtual std::istream & | ReadValue (std::istream &instr)=0
virtual std::string | Type () const
virtual bool | operator== (const DistiAttributeBase &r)
template<class valType >
DistiAttributeBase & | operator<< (const valType &val)
template<class valType >
DistiAttributeBase & | operator>> (valType &val)
virtual CallbackID | RegisterObserver (AttributeObserver *observer)
virtual void | UnregisterObserver (CallbackID id)
virtual void | NotifyObservers ()
Public Member Functions inherited from WeakReferenceableMixin
void | AddWeakReference (WeakReference *weakRef) override
void | NotifyWeakReferenceDestroyed (WeakReference *ref) override
virtual void | AddWeakReference (WeakReference *weakRef)=0
virtual void | NotifyWeakReferenceDestroyed (WeakReference *weakReference)=0

## Additional Inherited Members
Public Attributes inherited from DistiAttributeEnum< containerClass, const int, int >
DistiAttributeEnumDefList * | _pairList
| A list of name value pairs describing the enumeration.
containerClass * | _object
| Object that contains the attribute.
SetMethodType | _setMethod
| Set method member function pointer.
GetMethodType | _getMethod
| Get method member function pointer.
Protected Member Functions inherited from WeakReferenceableMixin
| WeakReferenceableMixin ()
virtual | ~WeakReferenceableMixin ()
Protected Attributes inherited from DistiAttributeBase
AttributeName | _name
CallbackMethodCallerBase * | _callback
ScopedPtr< DistiAttributeObserverList > | _observerList
bool | _localStorage
Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * | _weakRefs

## Detailed Description

template<class containerClass>
class disti::DistiAttributeColorMaterialModeEnum< containerClass >

An enumeration for ColorMaterialMode enum

## Constructor & Destructor Documentation

## ◆ DistiAttributeColorMaterialModeEnum()

DistiAttributeColorMaterialModeEnum | ( | containerClass * | frame,
|  | SetMethodType | setMethod,
|  | GetMethodType | getMethod,
|  | const AttributeName & | name
| ) |  |
| inline

Constructor

Parameters

  frame | The object containing the set and get methods.
  setMethod | The set method function pointer.
  getMethod | The get method function pointer.
  name | The name of this new attribute.

## Member Function Documentation

## ◆ OkToWrite()

virtual bool OkToWrite | ( |  | ) | const
| inline override virtual

This SHOULD be overriden by any derived objects that may not be ready to write at any point. The reason for this is the data is often written "NAME: VALUE". If Value is not available, we don't want to write "NAME: " first, so before writing "NAME: ", OkToWrite() can be called to see if it will have a valid value.

Returns
  True if this object is ready to have its WriteValue() called.

Reimplemented from DistiAttributeBase.

## ◆ Type()

std::string Type | ( |  | ) | const
| inline override virtual

This method isn't pure virtual to maintain backward compatibility with existing user code.

Returns
  The unmangled type name of the underlying storage.

Reimplemented from DistiAttributeBase.

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

- gls_metadata_attributes.h