GL Studio C++ Runtime API
DistiAttributeTexturePointArray Class Reference

#include <gls_metadata_attributes.h>

Inheritance diagram for DistiAttributeTexturePointArray:
DistiAttributeVertexArray< Vector > DistiAttributeBase WeakReferenceableMixin WeakReferenceable

Public Member Functions

 DistiAttributeTexturePointArray (CallbackMethodCallerBase *callback, const AttributeName &name, Vector *attribPtr, unsigned int numElements)
 
std::ostream & WriteValue (std::ostream &outstr) override
 
std::istream & ReadValue (std::istream &instr) override
 
- Public Member Functions inherited from DistiAttributeVertexArray< Vector >
void SetCompatabilityMode (bool mode)
 
 DistiAttributeVertexArray (CallbackMethodCallerBase *callback, const AttributeName &name, Vector **attribPtr, unsigned int *numVertices)
 
 DistiAttributeVertexArray (CallbackMethodCallerBase *callback, const AttributeName &name, Vector *attribPtr, unsigned int numElements)
 
bool OkToWrite () const override
 
std::ostream & WriteValue (std::ostream &outstr) override
 
std::istream & ReadValue (std::istream &instr) override
 
bool operator== (const DistiAttributeBase &rArg) override
 
std::string Type () const 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 Types inherited from DistiAttributeBase
typedef unsigned int CallbackID
 Type for unique identifiers.
 
- Protected Types inherited from DistiAttributeVertexArray< Vector >
typedef Vector * Tptr
 Shorthand typedef for a pointer to the template type.
 
- Protected Member Functions inherited from WeakReferenceableMixin
 WeakReferenceableMixin ()
 
virtual ~WeakReferenceableMixin ()
 
- Protected Attributes inherited from DistiAttributeVertexArray< Vector >
Vector ** _attribPtr
 Underlying storage for this attribute.
 
unsigned int * _numVertices
 The number of vertices in a variable length array.
 
unsigned int _numElements
 The number of vertices in a fixed length array.
 
bool _fixedArray
 If true, this array is not resizable.
 
bool _compatabilityMode
 If true, backward compatibility mode will be used, values will be read with scanf.
 
- Protected Attributes inherited from DistiAttributeBase
AttributeName _name
 
CallbackMethodCallerBase * _callback
 
ScopedPtr< DistiAttributeObserverList > _observerList
 
bool _localStorage
 
- Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * _weakRefs
 

Detailed Description

This is used specifically for changing from TexturePoints as Vertexs to TexturePoints as Vectors. It uses file version information to decide when expect what.

Constructor & Destructor Documentation

◆ DistiAttributeTexturePointArray()

DistiAttributeTexturePointArray ( CallbackMethodCallerBase *  callback,
const AttributeName &  name,
Vector *  attribPtr,
unsigned int  numElements 
)
inline

Constructor, for fixed arrays.

Parameters
callbackThe callback method function pointer to call back.
nameThe name of this new attribute.
attribPtrA pointer to existing storage for this attribute.
numElementsThe number of elements in the existing storage.

Member Function Documentation

◆ ReadValue()

std::istream & ReadValue ( std::istream &  instr)
inlineoverridevirtual

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.

Parameters
instrThe stream to read from.
Returns
The input stream in its current state.

Implements DistiAttributeBase.

◆ WriteValue()

std::ostream & WriteValue ( std::ostream &  outstr)
inlineoverridevirtual

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.

Parameters
outstrThe stream to write to.
Returns
The output stream in its current state.

Implements DistiAttributeBase.


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