GL Studio C++ Runtime API
Public Member Functions | List of all members
DistiAttributeMeshFaceArray Class Reference

#include <gltrimesh.h>

Inheritance diagram for DistiAttributeMeshFaceArray:
DistiAttributeBase WeakReferenceableMixin WeakReferenceable

Public Member Functions

 DistiAttributeMeshFaceArray (CallbackMethodCallerBase *callback, const AttributeName &name, GLMeshFace **attribPtr, unsigned int *numFaces, bool inRuntimeMode)
 
virtual bool OkToWrite () const override
 
virtual std::ostream & WriteValue (std::ostream &) override
 
virtual std::istream & ReadValue (std::istream &) 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 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 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

The DistiAttributeMeshFaceArray class. Defines metadata for the GlMeshFace type.

Constructor & Destructor Documentation

◆ DistiAttributeMeshFaceArray()

DistiAttributeMeshFaceArray ( CallbackMethodCallerBase *  callback,
const AttributeName &  name,
GLMeshFace **  attribPtr,
unsigned int *  numFaces,
bool  inRuntimeMode 
)

Constructor

Parameters
callbackThe callback to call when the attribute changes.
nameThe name of the new attribute.
attribPtrA pointer to the underlying mesh data.
numFacesA pointer to the underlying mesh face count.
inRuntimeModeMode for attribute parsing behavior.

Member Function Documentation

◆ OkToWrite()

virtual bool OkToWrite ( ) const
overridevirtual

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.

◆ ReadValue()

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

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()

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

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: