GL Studio API
Public Types | Public Member Functions | Public Attributes | Friends | List of all members
DistiAttributeBase Class Referenceabstract

#include <disti_metadata.h>

Inheritance diagram for DistiAttributeBase:
WeakReferenceableMixin WeakReferenceable DistiAttribute< T > DistiAttributeAlias DistiAttributeConnectionGlsAngularScaleDataArray DistiAttributeConnectionGlsLinearScaleDataArray DistiAttributeDictionaryAttribute DistiAttributeDictionaryAttributeSibling DistiAttributeDoubleArray DistiAttributeDynamicArray< T, showIndex > DistiAttributeEnum< containerClass, setType, getType > DistiAttributeEnumDirect< enumType > DistiAttributeFilePathClass DistiAttributeFixedString DistiAttributeFloatArray DistiAttributeHomogeneousItemArray< T > DistiAttributeMeshFaceArray DistiAttributeStdMap< Map_t > DistiAttributeStdVector< T, showIndex > DistiAttributeString DistiAttributeVertexArray< T > DistiAttributeVertexArray< Vertex > DistiAttributeViewDataArray DistiEmptyAttribute TexturePalette::DistiAttributeTexturePalette TexturePalette::DistiAttributeTexturePalette_V21 DistiAttribute< std::string > DistiAttribute< unsigned char > DistiAttribute< Vertex > DistiAttributeEnum< containerClass, const int, int > DistiAttributeEnum< containerClass, int, int > DistiAttributeEnum< GlsEyePoint, GlsEyePoint::FovConstraintType, GlsEyePoint::FovConstraintType > DistiAttributeEnum< GlsLightSource, int, int > DistiAttributeEnum< GlsSphere, glsSphereMapping_e, glsSphereMapping_e > DistiAttributeEnumDirect< glsImageCodec > DistiAttributeVertexArray< Vector >

Public Types

typedef unsigned int CallbackID
 Type for unique identifiers.
 

Public Member Functions

 DistiAttributeBase (CallbackMethodCallerBase *callback, const AttributeName &name, bool localStorage)
 
virtual DistiAttributeBaseoperator= (const DistiAttributeBase &oldClass)
 
const AttributeNameName () const
 
AttributeNameName ()
 
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 ()
 
virtual std::ostream & WriteValue (std::ostream &outstr)=0
 
virtual std::istream & ReadValue (std::istream &instr)=0
 
virtual bool operator== (const DistiAttributeBase &r)
 
template<class valType >
DistiAttributeBaseoperator<< (const valType &val)
 
template<class valType >
DistiAttributeBaseoperator>> (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)
 
void NotifyWeakReferenceDestroyed (WeakReference *ref)
 

Public Attributes

AttributeName _name
 
CallbackMethodCallerBase_callback
 
bool _localStorage
 

Friends

std::ostream & operator<< (std::ostream &outstr, const DistiAttributeBase &attribute)
 
std::istream & operator>> (std::istream &instr, DistiAttributeBase &attribute)
 

Additional Inherited Members

- Protected Member Functions inherited from WeakReferenceableMixin
 WeakReferenceableMixin (void)
 
virtual ~WeakReferenceableMixin ()
 
- Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * _weakRefs
 

Detailed Description

This is the base class for all Disti Attributes.

Constructor & Destructor Documentation

DistiAttributeBase ( CallbackMethodCallerBase callback,
const AttributeName name,
bool  localStorage 
)

Constructor

Parameters
callbackThe method to call when the value changes. A duplicate of the CallbackMethodCallerBase is created and stored internally.
nameThe name of the attribute
localStorageTrue if this DistiAttribute contains actual storage, rather than just a pointer to somebody elses storage

Member Function Documentation

virtual void CallCallback ( )
virtual

Calls callback CallType3 if it has been set

virtual bool Copyable ( ) const
virtual

Its not a word, but it means able to be copied This should return true if it makes sense for the data to be copied. By default, will only copy if it contains local storage

Reimplemented in DistiAttribute< T >, DistiAttribute< std::string >, DistiAttribute< Vertex >, and DistiAttribute< unsigned char >.

bool LocalStorage ( ) const

Returns true if this object has local storage

const AttributeName& Name ( ) const

Returns the name of this object

AttributeName& Name ( )

Returns the name of this object

virtual void NotifyObservers ( )
virtual

Triggers all observers to have their callbacks called. Typically called by the class that owns the DistiAttributeBase

Reimplemented in DistiAttributeAlias.

virtual bool OkToWrite ( ) const
virtual
DistiAttributeBase& operator<< ( const valType &  val)
inline

Allow for generic access to some data types. This will NOT work for types which: s << val does not work. In general if the WriteValue is overridden, then it probably will not work.

virtual DistiAttributeBase& operator= ( const DistiAttributeBase oldClass)
virtual
virtual bool operator== ( const DistiAttributeBase r)
virtual
DistiAttributeBase& operator>> ( valType &  val)
inline

Allows for generic access to some data types. This will NOT work for types which: s >> val does not work. In general if the ReadValue is overridden, then it probably will not work.

virtual std::istream& ReadValue ( std::istream &  instr)
pure virtual

Pure virtual because this is specific to the data type to be contained. This should be overridden to read the data from the stream. The value read could be encoded for being read from a file as a single string, or have its own special encoding specific to its underlying type. In the case of attribute strings, this will be the GLS file encoded value. The user is responsible for encoding the value themselves, or using WriteValue which should perform encoding to maintain symmetry.

Implemented in DistiAttributeEnumDirect< enumType >, DistiAttributeEnumDirect< glsImageCodec >, DistiEmptyAttribute, DistiAttributeProperty< containerT, T, SetArgT >, DistiAttributeHomogeneousItemArray< T >, DistiAttributeStdVector< T, showIndex >, DistiAttributeDynamicArray< T, showIndex >, DistiAttributeAlias, DistiAttributeTexturePointArray, DistiAttributeEnum< containerClass, setType, getType >, DistiAttributeEnum< GlsLightSource, int, int >, DistiAttributeEnum< GlsSphere, glsSphereMapping_e, glsSphereMapping_e >, DistiAttributeEnum< containerClass, const int, int >, DistiAttributeEnum< GlsEyePoint, GlsEyePoint::FovConstraintType, GlsEyePoint::FovConstraintType >, DistiAttributeEnum< containerClass, int, int >, GlsTextCharAttr, DistiAttributeVertexArray< Vertex >, DistiAttributeVertexArray< T >, DistiAttributeVertexArray< Vector >, DistiAttributeStdMap< Map_t >, DistiAttribute< T >, DistiAttribute< std::string >, DistiAttribute< Vertex >, DistiAttribute< unsigned char >, DistiAttributeDictionaryAttributeSibling, DistiAttributeDictionaryAttribute, DistiAttributeLocation, DistiAttributeStdString, DistiAttributeFixedString, DistiAttributeEncodedStdString, DistiAttributeEncodedString, DistiAttributeString, TexturePalette::DistiAttributeTexturePalette, DistiAttributeConnectionGlsAngularScaleDataArray, TexturePalette::DistiAttributeTexturePalette_V21, DistiAttributeConnectionGlsLinearScaleDataArray, DistiAttributeViewDataArray, DistiAttributeMeshFaceArray, DistiAttributeCWDRelativePath, DistiAttributeFilePathClass, DistiAttributeDoubleArray, DistiAttributeFloatArray, DistiAttributeUCharOrBool, DistiAttribute< T >, DistiAttribute< T >, DistiAttribute< T >, and DistiAttribute< T >.

virtual CallbackID RegisterObserver ( AttributeObserver observer)
virtual

Register a callback that is called when the value of the attribute changes. If multiple oservers are registered, they will be notified in the order they registered. DistiAttributeBase takes ownership of the observer and will delete it.

Parameters
observerthe observer to notify. It is automatically unregistered and destroyed when it becomes invalid.
Returns
an id that can be used to unregister the observer

Reimplemented in DistiAttributeAlias.

virtual void ResetValueChanged ( )
virtual

Saves the current value for later comparison by ValueChanged() This does nothing in the base class

Reimplemented in DistiAttributeAlias.

virtual void UnregisterObserver ( CallbackID  id)
virtual

Unregister an observer

Parameters
idthe id returned when the observer was registered

Reimplemented in DistiAttributeAlias.

virtual bool ValueChanged ( )
virtual

Returns true if the object's value has changed since calling ResetValueChanged() However, it is not implmented in the base class and will always return true if not overridden

Reimplemented in DistiAttributeAlias.

virtual double ValueFloat ( )
virtual

Allows for faster access to floating-point types than the more generic stream operators. However, it is only faster if it is overridden.

Reimplemented in DistiAttributeProperty< containerT, T, SetArgT >, DistiAttributeAlias, DistiAttribute< T >, DistiAttribute< std::string >, DistiAttribute< Vertex >, and DistiAttribute< unsigned char >.

virtual void ValueFloat ( double  val)
virtual

Allows for faster access to floating-point types than the more generic stream operator. However, it is only faster if it is overridden.

Reimplemented in DistiAttributeProperty< containerT, T, SetArgT >, DistiAttributeAlias, DistiAttribute< T >, DistiAttribute< std::string >, DistiAttribute< Vertex >, and DistiAttribute< unsigned char >.

virtual long ValueInt ( )
virtual
virtual void ValueInt ( long  val)
virtual
virtual std::string ValueString ( )
virtual

Returns the std::string version of the attribute data. Here in the base class it uses WriteValue() If this particular attribute's underlying type is a string, this returns the unencoded value, suitable for users. If a file encoded value is required, call WriteValue instead.

Reimplemented in DistiAttributeProperty< containerT, T, SetArgT >, DistiAttributeAlias, DistiAttributeEncodedStdString, and DistiAttributeEncodedString.

virtual void ValueString ( const std::string &  s)
virtual

Sets the value from a std::string argument. Here in the base class it uses ReadValue() If this particular attribute's underlying type is a string, this should not be set to an encoded value. If needing to set from an encoded value, call ReadValue instead.

Reimplemented in DistiAttributeProperty< containerT, T, SetArgT >, DistiAttributeAlias, DistiAttributeEncodedStdString, and DistiAttributeEncodedString.

virtual std::ostream& WriteValue ( std::ostream &  outstr)
pure virtual

Pure virtual because this is specific to the data type to be contained. This should be overridden to write the data to the stream. The value written could be encoded for writing to a file as a single string, or have its own special encoding specific to its underlying type. In the case of attribute strings, this will be the GLS file encoded value. The user is responsible for decoding the value themselves, or using ReadValue which should perform decoding to maintain symmetry.

Implemented in DistiAttributeEnumDirect< enumType >, DistiAttributeEnumDirect< glsImageCodec >, DistiEmptyAttribute, DistiAttributeProperty< containerT, T, SetArgT >, DistiAttributeHomogeneousItemArray< T >, DistiAttributeStdVector< T, showIndex >, DistiAttributeDynamicArray< T, showIndex >, DistiAttributeAlias, DistiAttributeTexturePointArray, GlsTextCharAttr, DistiAttributeEnum< containerClass, setType, getType >, DistiAttributeEnum< GlsLightSource, int, int >, DistiAttributeEnum< GlsSphere, glsSphereMapping_e, glsSphereMapping_e >, DistiAttributeEnum< containerClass, const int, int >, DistiAttributeEnum< GlsEyePoint, GlsEyePoint::FovConstraintType, GlsEyePoint::FovConstraintType >, DistiAttributeEnum< containerClass, int, int >, DistiAttributeVertexArray< Vertex >, DistiAttributeVertexArray< T >, DistiAttributeVertexArray< Vector >, DistiAttributeStdMap< Map_t >, DistiAttribute< T >, DistiAttribute< std::string >, DistiAttribute< Vertex >, DistiAttribute< unsigned char >, DistiAttributeDictionaryAttributeSibling, DistiAttributeDictionaryAttribute, DistiAttributeLocation, DistiAttributeStdString, DistiAttributeFixedString, DistiAttributeEncodedStdString, DistiAttributeEncodedString, DistiAttributeString, TexturePalette::DistiAttributeTexturePalette, DistiAttributeConnectionGlsAngularScaleDataArray, TexturePalette::DistiAttributeTexturePalette_V21, DistiAttributeConnectionGlsLinearScaleDataArray, DistiAttributeViewDataArray, DistiAttributeMeshFaceArray, DistiAttributeCWDRelativePath, DistiAttributeFilePathClass, DistiAttributeDoubleArray, DistiAttributeFloatArray, DistiAttributeUCharOrBool, DistiAttribute< T >, and DistiAttribute< T >.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  outstr,
const DistiAttributeBase attribute 
)
friend

Allows this class to send to a stream. Internally it uses WriteValue()

std::istream& operator>> ( std::istream &  instr,
DistiAttributeBase attribute 
)
friend

Allows this class to receive from a stream. Internally it uses ReadValue()

Member Data Documentation

The callback which is called when the value of this object changes

bool _localStorage

_localStorage is true if this attributes data should be copied. It would typically be set false if the data is stored externally, and there is no need to copy the data through metadata. It is also used to determine if storage should be deleted.

The name of this attribute


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