GL Studio C++ Runtime API
SplashDisplay Class Reference
Inheritance diagram for SplashDisplay:
ComponentBase Group DisplayFrame DisplayObject AttributeChangedNotifier AttributeChangedNotifier WeakReferenceableMixin WeakReferenceable

Public Member Functions

void CreateObjects (void)
virtual void Initialize ()
virtual void Calculate (double time)
virtual DisplayObjectCloneObject (bool generateNames=false)
virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array)
- Public Member Functions inherited from ComponentBase
 ComponentBase (int generateInstance=0)
virtual ~ComponentBase ()
virtual void SetAvailableAttributes (unsigned int value)
bool AbsolutePlacement () const
virtual void AbsolutePlacement (bool val)
virtual void ClearDragAndFocus ()
virtual void CopyGeometry (DisplayObject *src)
virtual void CopyProperties (DisplayObject *src)
virtual void DeleteAllChildren ()
virtual void Draw ()
virtual DisplayObjectFindByNameSameFrame (const char *name)
virtual void GetExtents (float &x, float &y, float &z, float &x1, float &y1, float &z1)
virtual void GetTransformedExtents (Vector &min, Vector &max, const GlsMatrixType &matrix, bool resetMinMax=true)
virtual DisplayObjectHandleInput (DisplayEvent *ev)
virtual void Init ()
LiveComponentAccessorLiveAccessor ()
virtual const VertexLocation (void) const
virtual void Location (const Vertex &v)
virtual void Location (float x, float y, float z)
virtual void Parent (DisplayFrame *par)
DisplayFrameParentDisplayFrame () const
void ParentDisplayFrame (DisplayFrame *val)
virtual DisplayObjectPick3D (const Vector &winLoc, const Vector &logicalCoords, float scale, const Vector &directionVector, Vector &collisionWinLoc, const OpenGLMatrices &drawnMatrices)
virtual void PreDraw (const OpenGLMatrices &current, Culler &culler)
virtual void GetResources (std::ostream &outstr, GlsResourceFilter *filter=NULL)
virtual DistiAttributeBaseResource (const char *name)
virtual void Rotate (const Vector &orig, float angle, const Vector &axis)
virtual void Scale (float px, float py, float pz, Vertex *parentAnchor, int handleBar=0)
virtual void SetRedraw (void)
virtual void Translate (float tr[])
virtual void Translate (float x, float y, float z)
virtual void UseParentsLighting (const bool &)
virtual bool UseParentsLighting ()
virtual int TextureIndex ()
virtual void TextureIndex (int index)
void SetValue (int spec, va_list &args)
virtual InputHandlerGetInputHandler ()
void NotifyAttributeChanged (const AttributeName &name)
- Public Member Functions inherited from Group
DisplayObjectFindByName (const char *name)
DisplayObjectFindByName (DisplayObject *obj)
DisplayObjectFindByQualifiedName (const char *name)
DisplayObjectFindNonRecursive (DisplayObject *obj)
DisplayObjectArrayObjects (void)
DisplayObjectItem (unsigned int index)
bool PerformGroupCullCheck (void) const
void PerformGroupCullCheck (bool mode)
bool CullTestChildren (void) const
void CullTestChildren (bool mode)
unsigned int Count (void) const
DisplayObjectPtr operator[] (unsigned int index)
DisplayObjectFirstObject ()
DisplayObjectLastObject (void)
bool IsEmpty () const
int Position (DisplayObject *obj)
 Group (int generateInstance=0)
 Group (const Group &group, bool generateNames)
void InitialGroupCount (unsigned int cnt)
virtual ~Group ()
virtual bool Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint)
virtual void TranslateVertices (float x, float y, float z)
virtual void InsertObject (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=-1)
virtual bool DeleteObject (DisplayObject *obj, bool recalculateBoundingbox=true)
virtual void ReorderObject (unsigned int oldIndex, unsigned int newIndex)
virtual void PushObject (DisplayObject *obj)
virtual void DeleteVertex (unsigned int index)
virtual void InsertVertex (unsigned int index)
virtual void SetGroupLocation (const Vertex &v)
virtual void CalculateTextureCoordinates (void)
virtual void LineWidth (float width)
virtual float LineWidth (void)
virtual void LineStipplePattern (int pattern)
virtual int LineStipplePattern (void)
virtual void LineStippleMultiplier (int mult)
virtual int LineStippleMultiplier (void)
virtual int PolygonMode (void)
virtual void PolygonMode (int mode)
virtual void PolygonEnd (const int mode)
virtual int PolygonEnd (void)
virtual void Shading (const int mode)
virtual int Shading (void)
virtual void DepthTest (unsigned char mode)
virtual int DepthTest (void)
virtual void AntiAlias (bool mode)
virtual bool AntiAlias (void)
virtual void AlphaMode (int mode)
virtual int AlphaMode (void)
virtual void CullBackFace (const bool mode)
virtual bool CullBackFace (void)
virtual bool LightingEnabled ()
virtual void LightingEnabled (bool lighting)
virtual void SetBlendColor (const GlsColor &color)
virtual GlsColor GetBlendColor (void)
virtual void SetColor (const GlsColor &color)
virtual GlsColor GetColor (void)
virtual void SetFillColor (const GlsColor &color)
virtual GlsColor GetFillColor (void)
virtual void TextureRepeat (const int rep)
virtual bool TextureRepeat (void)
virtual void TextureMappingTechnique (const int map)
virtual int TextureMappingTechnique (void)
virtual void TextureMinificationFilter (const int filter)
virtual int TextureMinificationFilter (void)
virtual void TextureMagnificationFilter (const int filter)
virtual int TextureMagnificationFilter (void)
CompatabilityListItemFirst ()
CompatabilityListItemLast ()
- Public Member Functions inherited from DisplayObject
 DisplayObject (float x, float y, float z)
 DisplayObject (const DisplayObject &object, const bool generateNames)
virtual ~DisplayObject (void)
void Destroy ()
void ApplyTextureSettings (int textureIndex=-1)
DistiAttribDictAttributes ()
void GetBlendColor (unsigned char color[])
void GetBlendColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
void SetBlendColor (unsigned char color[])
void SetBlendColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
bool BlinkedOff (void)
virtual bool Blinking (void)
virtual void Blinking (const bool blink)
virtual float BlinkRate (void)
virtual void BlinkRate (const float rate)
const VectorBoundingVolumeCenter () const
void BoundingVolumeCenter (const Vector &center)
bool BoundingVolumeHit (const Vector &start, const Vector &direction)
float BoundingVolumeRadius () const
void BoundingVolumeRadius (float radius)
void CalculateCollisionPoint (const Vector &pickLoc, const Vector &directionVector, Vector *collisionPoint)
virtual void CalculateParentBoundingBox (void)
bool GetTexturePointTransformationMatrix (GlsMatrixType &world2tex)
CallbackMethodCallerBaseCallbackCaller () const
void CallbackCaller (CallbackMethodCallerBase *cb)
virtual void GetCenter (Vector &center)
void GetColor (unsigned char c4[])
void GetColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
void SetColor (unsigned char c4[])
void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
virtual void CopyHierarchyProperties (DisplayObject *src, bool copyName)
bool Culled () const
bool CullTest (const GlsMatrixType *matrix, const Culler &culler)
GlsMatrixTypeDcsMatrix ()
void DcsMatrix (const GlsMatrixType &matrix)
const GlsMatrixTypeDrawMatrix ()
bool NeedCalcDrawMatrix ()
void DynamicRotate (float angle, int axis)
void DynamicRotate (const Vector &v)
void DynamicRotate (float angle[])
virtual void DynamicRotate (float x, float y, float z)
virtual void DynamicRotateRelative (float angle, int axis)
virtual float DynamicRotation (int axis)
virtual Vector DynamicScale ()
virtual void DynamicScale (float x, float y, float z)
void DynamicScale (const Vector &scale)
virtual void DynamicTranslate (float x, float y, float z, bool relative=false)
void DynamicTranslate (const Vertex &amount, bool relative)
void DynamicTranslate (const Vector &amount)
virtual void DynamicTranslate (float amount, int axis, bool relative=false)
virtual float DynamicTranslation (int axis)
virtual Vector DynamicTranslation ()
DisplayObjectEditor * Editor ()
const DisplayObjectEditor * Editor () const
void Editor (DisplayObjectEditor *editor)
void GetExtentsDCS (Vector &min, Vector &max)
void GetFillColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
void GetFillColor (unsigned char c4[])
void SetFillColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
void SetFillColor (unsigned char c4[])
virtual DisplayObjecthandle (DisplayEvent *ev)
virtual bool HitUtil (float x, float y, float z, float scale, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector, Vector *collisionPoint)
char * InstanceName (void)
void InstanceName (const char *name)
virtual void GetLocation (Vertex &v)
virtual void GetLocation (float &x, float &y, float &z)
float X (void) const
float Y (void) const
float Z (void) const
void X (const float x)
void Y (const float y)
void Z (const float z)
virtual int MaterialIndex ()
virtual void MaterialIndex (int index)
virtual DynamicArray< int > & MaterialIndices ()
virtual void MaterialIndices (DynamicArray< int > indices)
GlsMatrixTypeModelMatrix ()
bool NeedCalculate ()
VectorNormals ()
virtual void SetNormals (unsigned int nPoints, Vector *vertices)
void VaSetNormals (unsigned int nPoints,...)
unsigned int NumberOfVertices () const
virtual float ObjectDepth (void)
virtual float ObjectHeight (void)
virtual float ObjectWidth (void)
virtual void SetOrigin (const Vertex &vert)
DisplayFrameParent (void) const
virtual void ParentGroup (Group *group)
GroupParentGroup (void) const
unsigned char Pickable ()
virtual void Pickable (unsigned char pick)
GlsMatrixTypeProjMatrix ()
virtual void ReallocateVertices (unsigned int numVertices, bool initializeNew, bool copyOld)
virtual float RelativeAngle (const float x, const float y)
void RestoreAlpha (void)
void RestoreAntiAlias (void)
void RestoreLighting (void)
void RestoreLineStyle (void)
const VertexRotationPoint ()
virtual void RotationPoint (const Vertex &v)
virtual void RotationPoint (float x, float y, float z)
virtual void GetRotationPoint (Vertex &v)
virtual void Rotate (float angle, int axis=Z_AXIS)
virtual void Rotate (const Vector &origin, float angle, int axis=Z_AXIS)
void SaveMatrices ()
void Scale (int handleBar, float px, float py, Vertex *anchor=NULL)
void Set (int spec,...)
bool SetupAlpha (void)
bool SetupAntiAlias (void)
void SetupDepthTest (void)
void SetupLighting (void)
bool SetupLineStyle (void)
void SetupPolyDrawStyle (void)
void SetupShading (void)
bool SetupTexture (void)
virtual void SetTexCoords (unsigned int nPoints, Vector *new_tex_coord, bool isVectorArray=true)
void SetTexCoords (unsigned int nPoints, Vertex *new_tex_coord)
void VaSetTexCoords (unsigned int nPoints,...)
VectorTextureCoordinates (void)
VectorGetTextureCoordinates (void)
virtual VectorGetTexturePoints (void)
virtual void UpdateBoundingVolume (void)
void * UserData (void) const
void UserData (void *data)
virtual void SetVertexColor (unsigned int vertex, unsigned char CurrentFillColor[])
virtual VertexVertices ()
virtual void SetVertices (unsigned int nPoints, Vertex *vertices)
void VaSetVertices (unsigned int nPoints,...)
int * ViewMatrix ()
bool Visible (void) const
bool Visibility (void) const
virtual void Visibility (const bool vis)
virtual Vector WorldRotationPoint (void)
virtual void WorldRotationPoint (const Vector &vert)
virtual Vertex WorldVertex (unsigned int i)
virtual void WorldVertex (unsigned int i, const Vertex &vert)
bool LogicalToWindow (const Vector &logical, Vector &winLoc, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())
bool WindowToLogical (const Vector &winLoc, Vector &logical, Vector *directionVector=NULL, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())
void LogicalToDCS (Vector logicalPoint, Vector &objectLocal, const Vector *directionVector, const Vector &planeNormal=Vector(0, 0, 1), const Vector &planePoint=Vector(), const GlsMatrixType *dcsMatrix=NULL)
void DCSToLogical (Vector dcsPoint, Vector &logicalPoint, const GlsMatrixType *dcsMatrix=NULL)
virtual bool GetPlaneVectorPoints (Vertex &p1, Vertex &p2, Vertex &p3, Vertex &planeVector)
void NotifyAttributeChanged (const AttributeName &name)
- Public Member Functions inherited from AttributeChangedNotifier
virtual ~AttributeChangedNotifier ()
- Public Member Functions inherited from WeakReferenceableMixin
void AddWeakReference (WeakReference *weakRef)
void NotifyWeakReferenceDestroyed (WeakReference *ref)
- Public Member Functions inherited from DisplayFrame
 DisplayFrame (int width, int height, bool allocateObjects=true)
void ClearBitfield (GLbitfield bitField)
GLbitfield ClearBitfield ()
virtual void DragObject (DisplayObject *obj)
virtual DisplayObjectDragObject (void)
virtual void ClearDrag ()
virtual void FocusObject (DisplayObject *obj)
virtual DisplayObjectFocusObject (void)
virtual void ClearFocus ()
virtual void MultitouchEnabled (bool enabled)
virtual bool MultitouchEnabled (void)
virtual DisplayObjectHandleDisplayEvent (DisplayEvent *ev)
virtual void WriteResources (const char *filename, GlsResourceFilter *filter=NULL)
virtual void ReadResources (const char *filename)
virtual void SetResources (std::istream &instr)
void SetResource (const std::string &resourceName, const std::string &resourceVal)
std::string GetResource (const std::string &resourceName)
virtual char * GetResource_CRTClean (const char *name)
virtual void GetResourceFree_CRTClean (char *memoryToFree)
virtual char * GetResources_CRTClean (GlsResourceFilter *filter)
virtual void GetResourcesFree_CRTClean (char *memoryToFree)
virtual void SetResource_CRTClean (const char *name, const char *value)
virtual void SetResources_CRTClean (const char *buf)
void SetTexturePaletteSize (int cnt)
void Draw (void)
void InsertObject (DisplayObject *obj, int loc)
void PushObject (DisplayObject *obj)
int Width (void)
int Height (void)
void SetWidth (int w)
void SetHeight (int h)
bool CullingEnabled (void)
void CullingEnabled (const bool enabled)
DistiAttribDictFrameAttribDict (void)
const DistiAttribDictFrameAttribDict (void) const
DynamicMaterialArrayMaterialPalette (void)
ComponentLightMgrLightMgr (void)
void LightMgr (ComponentLightMgr *val)

Additional Inherited Members

- Public Types inherited from DisplayObject
enum  AvailableAttributesEnum
- Static Public Member Functions inherited from ComponentBase
static ComponentBaseCreateLiveComponent (const char *fileName=NULL, const char *className=NULL, bool performCreate=true, const GlsBuiltVersionInfo &callingVersion=GlsBuiltVersionInfo())
static bool CheckLiveVersion (ComponentBase *comp, const GlsBuiltVersionInfo &callingVersion=GlsBuiltVersionInfo())
- Static Public Member Functions inherited from DisplayObject
static void UseManualBlinkElapsedTime (bool useManualTime)
static void SetManualBlinkElapsedTime (double elapsedTime)
- Static Public Member Functions inherited from DisplayFrame
static void SetOpenGLDefaultState (bool saveVal)
static void RestoreOpenGLState (void)
- Public Attributes inherited from DisplayFrame
- Protected Member Functions inherited from ComponentBase
virtual void CalcDrawMatrix ()
virtual void CalculateMatrices (const OpenGLMatrices &newMatrices)
- Protected Member Functions inherited from Group
virtual void AddAvailableAttributes (unsigned int availableAttributes)
void GrowBoundingBox (DisplayObject *obj)
- Protected Member Functions inherited from DisplayObject
virtual void VaListSetVertices (unsigned int nPoints, va_list args)
virtual void VaListSetNormals (unsigned int nPoints, va_list args)
virtual void VaListSetTexCoords (unsigned int nPoints, va_list args)
void AllocateModelMatrix ()
bool ApplyDynamicRotation (void)
void CalcDrawMatrixIfExists ()
bool InsideVertexExtents (float x, float y, unsigned int nVerts, Vertex *verts, float tolerance)
void NeedCalculate (bool val)
void PickSetup (float x, float y, float z, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector)
void PickCleanup (Vertex *vertices, unsigned int vertex_cnt)
int GetApplicableTextureIndex ()
int GetApplicableTextureRepeat ()
- Protected Member Functions inherited from WeakReferenceableMixin
 WeakReferenceableMixin (void)
virtual ~WeakReferenceableMixin ()
- Protected Member Functions inherited from DisplayFrame
virtual void CurrentCursor (unsigned int cursor_id)
void CleanupDragMap ()
DisplayObjectGetDragObjectForCursor (unsigned int cursorID)
DisplayObjectFindDragObject ()
virtual float Scale (void)
- Protected Attributes inherited from ComponentBase
bool _absolutePlacement
GlsMatrixType _editorTransformMatrix
- Protected Attributes inherited from DisplayObject
int _alphaMode
bool _antiAlias
bool _attributesAdded
bool _blinking
float _blinkRate
GlsColor _color
bool _cullBackFace
GlsMatrixType _dcsMatrix
unsigned char _depthTest
unsigned char _lineStippleMultiplier
unsigned short _lineStipplePattern
float _lineWidth
Vertex _location
unsigned int _nTex_vertices
unsigned int _nVertices
unsigned char _polygonEnd
unsigned char _polygonMode
int _polygonOffset
unsigned char _shading
GlsColor _textureBlendColor
int _textureIndex
unsigned char _textureMagFilter
unsigned char _textureMinFilter
unsigned char _textureMap
Vector _texturePoints [4]
unsigned char _textureRepeat
void * _userData
int * _viewMatrix
bool _visible
- Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * _weakRefs
- Protected Attributes inherited from DisplayFrame
bool _cullingEnabled
int _width
int _height
float _lastPickedDepth
DynamicMaterialArray _materialPalette
GLbitfield _clearBitfield
std::string _componentHeaderFileName
unsigned int _currentCursor
bool _multitouchEnabled
unsigned int _cursorsDown

Member Function Documentation

virtual void Calculate ( double  time)

Call the Calculate method for all children

timeThe current time

Reimplemented from Group.

virtual DisplayObject* CloneObject ( bool  generateNames = false)

Copy+Create operation in one method. In derived classes, this method will create a new instance of the derived class and then copy the object into the new instance. The cut,copy,paste and undo operations use this method.

generateNamesWhether or not to generate new names for cloned objects
A new object, identical to the original, except for the instance name

Reimplemented from ComponentBase.

void CreateObjects ( void  )

In derived classes this creates all the geometry for the component

Reimplemented from ComponentBase.

virtual InterfaceListType* GetCppInterfaceDescription ( InterfaceListType addToThisList = NULL)

Get the details of the Cpp Interface The actual interface is exposed in compiled code.

addToThisListA list to add to and then return. Creates a new one if NULL.
A templated list. The caller must call the corresponding free method to safely free the memory.

Reimplemented from ComponentBase.

virtual void GetCppInterfaceDescriptionFree ( InterfaceListType array)

Frees the memory allocated by a previous GetCppInterfaceDescription call

arrayPointer to memory allocated by GetCppInterfaceDescription

Reimplemented from ComponentBase.

virtual void Initialize ( )

The GL Studio code generator allways derives a new Initialize method for the user This is called after all the objects are created.

Reimplemented from ComponentBase.

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