GL Studio C++ Runtime API
GlsMultiView Class Reference

#include <gls_multi_view.h>

Inheritance diagram for GlsMultiView:
Group DisplayObject AttributeChangedNotifier WeakReferenceableMixin WeakReferenceable

Classes

class  ViewData
 

Public Types

enum  { CLEAR_BG_OFF = 0 , CLEAR_BG_DEPTH_AND_COLOR = 1 , CLEAR_BG_DEPTH = 2 , CLEAR_BG_COLOR = 3 }
 
enum  ViewDrawStateEnum { GEOMETRY_ONLY = 0 , GEOMETRY_AND_VIEWS , VIEWS_ONLY }
 
typedef Group _BaseClass
 Deprecated typedef for the base class.
 
typedef Group BaseClass
 Typedef for the base class.
 
typedef DynamicArray< ViewDataViewDataArray
 Shorthand typedef for a list of views.
 
- Public Types inherited from Group
typedef DisplayObject _BaseClass
 Deprecated typedef for the base class.
 
typedef DisplayObject BaseClass
 Typedef for the base class.
 
- Public Types inherited from DisplayObject
enum  AvailableAttributesEnum {
  GLS_ATTRIBUTES_BASIC = 1 , GLS_ATTRIBUTES_DYNAMIC = 2 , GLS_ATTRIBUTES_APPEARANCE = 4 , GLS_ATTRIBUTES_GEOMETRY = 8 ,
  GLS_ATTRIBUTES_SPECIALIZED = 16 , GLS_ATTRIBUTES_ALL = ~0 , GLS_ATTRIBUTES_NONE = 0
}
 

Public Member Functions

 GlsMultiView (int generateInstance=FALSE)
 
 GlsMultiView (const GlsMultiView &that, const bool generateNames)
 
virtual ~GlsMultiView ()
 
virtual void SetAvailableAttributes (unsigned int value) DISTI_METHOD_OVERRIDE
 
virtual DisplayObjectCloneObject (bool generateNames=FALSE) DISTI_METHOD_OVERRIDE
 
virtual void PreDraw (const OpenGLMatrices &parentMatrices, Culler &culler) DISTI_METHOD_OVERRIDE
 
virtual void Draw () DISTI_METHOD_OVERRIDE
 
virtual void CopyProperties (DisplayObject *src) DISTI_METHOD_OVERRIDE
 
virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL) DISTI_METHOD_OVERRIDE
 
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array) DISTI_METHOD_OVERRIDE
 
virtual DisplayObjectPick3D (const Vector &winLoc, const Vector &logicalCoords, float scale, const Vector &directionVector, Vector &collisionWinLoc, const OpenGLMatrices &drawnMatrices) DISTI_METHOD_OVERRIDE
 
virtual DisplayObjecthandle (DisplayEvent *ev) DISTI_METHOD_OVERRIDE
 
virtual DistiAttributeBaseResource (const char *name) DISTI_METHOD_OVERRIDE
 
virtual void GetResources (std::ostream &outstr, GlsResourceFilter *filter=NULL) DISTI_METHOD_OVERRIDE
 
virtual void SetValue (int spec, va_list &args) DISTI_METHOD_OVERRIDE
 
void ViewDrawingState (ViewDrawStateEnum)
 Set the ViewDrawingState.
 
ViewDrawStateEnum ViewDrawingState ()
 
unsigned int ViewCount () const
 
ViewDataView (unsigned int viewNumber)
 
ViewDataArrayViewArray ()
 
int LastViewPicked () const
 
void EmitViewDrawEvents (const bool &)
 
bool EmitViewDrawEvents () const
 
void DrawView (unsigned int viewNumber, ViewData *view)
 
- Public Member Functions inherited from Group
virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL) override
 
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array) override
 
DisplayObjectFindByName (const char *name)
 
virtual DisplayObjectFindByNameSameFrame (const char *name)
 
DisplayObjectFindByName (DisplayObject *obj)
 
DisplayObjectFindByQualifiedName (const char *name)
 
DisplayObjectFindNonRecursive (DisplayObject *obj)
 
DisplayObjectArrayObjects ()
 
const DisplayObjectArrayObjects () const
 
DisplayObjectItem (unsigned int index)
 
bool PerformGroupCullCheck () const
 
void PerformGroupCullCheck (bool mode)
 
bool CullTestChildren () const
 
void CullTestChildren (bool mode)
 
unsigned int Count () const
 
DisplayObjectPtr operator[] (unsigned int index)
 
const DisplayObjectoperator[] (unsigned int index) const
 
DisplayObjectFirstObject ()
 
DisplayObjectLastObject ()
 
bool IsEmpty () const
 
int Position (const DisplayObject *obj) const
 
 Group (int generateInstance=0)
 
 Group (const Group &group, bool generateNames)
 
void InitialGroupCount (unsigned int cnt)
 
virtual ~Group ()
 
virtual void DeleteAllChildren ()
 
virtual void SetAvailableAttributes (unsigned int value) override
 
virtual DisplayObjectCloneObject (bool generateNames=false) override
 
virtual void CopyGeometry (DisplayObject *src) override
 
virtual void CopyProperties (DisplayObject *src) override
 
virtual void Draw () override
 
virtual void PreDraw (const OpenGLMatrices &current, Culler &culler) override
 
virtual bool Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint) override
 
virtual DisplayObjectPick3D (const Vector &winLoc, const Vector &logicalCoords, float scale, const Vector &directionVector, Vector &collisionWinLoc, const OpenGLMatrices &drawnMatrices) override
 
virtual void Parent (DisplayFrame *par) override
 
void SetPainter (GlsPainter *painter) override
 
virtual void CalculateBoundingBox ()
 
virtual void Location (const Vertex &v) override
 
virtual void Location (float x, float y, float z) override
 
virtual void Translate (float x, float y, float z) override
 
virtual void Translate (float transAmount[]) override
 
virtual void TranslateVertices (float x, float y, float z) override
 
virtual void TranslateVertices (float transAmount[])
 
virtual void GetExtents (float &x, float &y, float &z, float &x1, float &y1, float &z1) override
 
virtual void GetTransformedExtents (Vector &min, Vector &max, const GlsMatrixType &matrix, bool resetMinMax=true) override
 
virtual void Rotate (const Vector &orig, float angle, const Vector &axis) override
 
virtual void Scale (float scale_x, float scale_y)
 
void Scale (float scale_x, float scale_y, float scale_z, Vertex *anchor=NULL, int handle=0) override
 
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)
 
void DeleteVertexAt (unsigned) override
 
void InsertVertexAt (unsigned) override
 
virtual void SetGroupLocation (const Vertex &v)
 
virtual void GetResources (std::ostream &outstr, GlsResourceFilter *filter=NULL) override
 
virtual void CalculateTextureCoordinates () override
 
virtual void LineWidth (float width) override
 
virtual float LineWidth () override
 
virtual void LineStipplePattern (int pattern) override
 
virtual int LineStipplePattern () override
 
virtual void LineStippleMultiplier (int mult) override
 
virtual int LineStippleMultiplier () override
 
virtual int PolygonMode () override
 
virtual void PolygonMode (int mode) override
 
virtual void PolygonEnd (const int mode) override
 
virtual int PolygonEnd () override
 
virtual void Shading (const int mode) override
 
virtual int Shading () override
 
virtual void DepthTest (unsigned char mode) override
 
virtual int DepthTest () override
 
virtual void AntiAlias (bool mode) override
 
virtual bool AntiAlias () override
 
virtual void AlphaMode (int mode) override
 
virtual int AlphaMode () override
 
virtual void CullBackFace (const bool mode) override
 
virtual bool CullBackFace () override
 
virtual bool LightingEnabled () override
 
virtual void LightingEnabled (bool lighting) override
 
virtual void SetBlendColor (const GlsColor &color) override
 
virtual GlsColor GetBlendColor () override
 
virtual void SetColor (const GlsColor &color) override
 
virtual GlsColor GetColor () override
 
virtual void SetFillColor (const GlsColor &color) override
 
virtual GlsColor GetFillColor () override
 
virtual void TextureRepeat (const int rep) override
 
virtual void TextureMappingTechnique (const int map) override
 
virtual int TextureMappingTechnique () override
 
virtual void TextureMinificationFilter (const int filter) override
 
virtual int TextureMinificationFilter () override
 
virtual void TextureMagnificationFilter (const int filter) override
 
virtual int TextureMagnificationFilter () override
 
virtual void Calculate (double time) override
 
CompatabilityListItemFirst ()
 
CompatabilityListItemLast ()
 
virtual void Parent (DisplayFrame *par)
 
DisplayFrameParent () const
 
virtual const VertexLocation () const
 
virtual void Location (const Vertex &v)
 
virtual void Location (float x, float y, float z)
 
virtual void Rotate (float angle, int axis=Z_AXIS)
 
virtual void Rotate (const Vector &origin, float angle, int axis=Z_AXIS)
 
virtual void Rotate (const Vector &orig, float angle, const Vector &axis)
 
virtual void SetBlendColor (const GlsColor &color)
 
void SetBlendColor (unsigned char color[])
 
void SetBlendColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
void GetBlendColor (unsigned char color[])
 
void GetBlendColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
virtual GlsColor GetBlendColor ()
 
virtual void SetColor (const GlsColor &color)
 
void SetColor (unsigned char c4[])
 
void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
virtual GlsColor GetColor ()
 
void GetColor (unsigned char c4[])
 
void GetColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
void SetFillColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
void SetFillColor (unsigned char c4[])
 
virtual void SetFillColor (const GlsColor &color)
 
void GetFillColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
void GetFillColor (unsigned char c4[])
 
virtual GlsColor GetFillColor ()
 
virtual bool TextureRepeat ()
 
virtual void TextureRepeat (const int rep)
 
- Public Member Functions inherited from DisplayObject
 DisplayObject (float x, float y, float z)
 
 DisplayObject (const DisplayObject &object, const bool generateNames)
 
virtual ~DisplayObject ()
 
void Destroy ()
 
virtual void SetAvailableAttributes (unsigned int value)
 
virtual void AlphaMode (int mode)
 
virtual int AlphaMode ()
 
virtual bool AntiAlias ()
 
virtual void AntiAlias (bool alias)
 
void ApplyTextureSettings (int textureIndex=-1)
 
DistiAttribDictAttributes ()
 
const DistiAttribDictAttributes () const
 
virtual void SetBlendColor (const GlsColor &color)
 
void GetBlendColor (unsigned char color[])
 
void GetBlendColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
virtual GlsColor GetBlendColor ()
 
void SetBlendColor (unsigned char color[])
 
void SetBlendColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
virtual bool BlinkedOff ()
 
virtual bool Blinking ()
 
virtual void Blinking (const bool blink)
 
virtual float BlinkRate ()
 
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)
 
virtual void Calculate (double time)
 
void CalculateCollisionPoint (const Vector &pickLoc, const Vector &directionVector, Vector *collisionPoint)
 
virtual void CalculateParentBoundingBox ()
 
virtual void CalculateTextureCoordinates ()
 
bool GetTexturePointTransformationMatrix (GlsMatrixType &world2tex)
 
CallbackMethodCallerBaseCallbackCaller () const
 
void CallbackCaller (CallbackMethodCallerBase *cb)
 
virtual void GetCenter (Vector &center)
 
virtual DisplayObjectCloneObject (bool generateNames=false)=0
 
virtual GlsColor GetColor ()
 
void GetColor (unsigned char c4[])
 
void GetColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
virtual void SetColor (const GlsColor &color)
 
void SetColor (unsigned char c4[])
 
void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
virtual void CopyGeometry (DisplayObject *src)
 
virtual void CopyHierarchyProperties (DisplayObject *src, bool copyName)
 
virtual void CopyProperties (DisplayObject *src)
 
virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)
 
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array)
 
virtual void CullBackFace (const bool val)
 
virtual bool CullBackFace ()
 
bool Culled () const
 
void Culled (bool val)
 
bool CullTest (const GlsMatrixType *matrix, const Culler &culler)
 
GlsMatrixTypeDcsMatrix ()
 
GlsMatrixType DcsMatrix () const
 
void DcsMatrix (const GlsMatrixType &matrix)
 
virtual void DeleteVertexAt (unsigned int index)
 
virtual void DeleteVertex (unsigned int indexAfter) final
 
virtual int DepthTest ()
 
virtual void DepthTest (unsigned char zbuf)
 
virtual void Draw ()=0
 
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 DynamicRotation ()
 
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)
 
virtual void GetExtents (float &x, float &y, float &z, float &x1, float &y1, float &z1)
 
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[])
 
virtual GlsColor GetFillColor ()
 
void SetFillColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
void SetFillColor (unsigned char c4[])
 
virtual void SetFillColor (const GlsColor &color)
 
virtual void FinishObject ()
 
virtual void GenerateInstanceName ()
 
virtual DisplayObjecthandle (DisplayEvent *ev)
 
virtual bool Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint)
 
virtual bool HitUtil (float x, float y, float z, float scale, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector, Vector *collisionPoint)
 
virtual void InsertVertexAt (unsigned int index)
 
virtual void InsertVertex (unsigned int indexAfter) final
 
char * InstanceName ()
 
const char * InstanceName () const
 
void InstanceName (const char *name)
 
virtual bool LightingEnabled ()
 
virtual void LightingEnabled (bool lighting)
 
virtual int LineStippleMultiplier ()
 
virtual void LineStippleMultiplier (int mult)
 
virtual int LineStipplePattern ()
 
virtual void LineStipplePattern (int pattern)
 
virtual float LineWidth ()
 
virtual void LineWidth (float width)
 
virtual const VertexLocation () const
 
virtual void Location (const Vertex &v)
 
virtual void Location (float x, float y, float z)
 
virtual void GetLocation (Vertex &v)
 
virtual void GetLocation (float &x, float &y, float &z)
 
float X () const
 
float Y () const
 
float Z () 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 ()
 
virtual float ObjectHeight ()
 
virtual float ObjectWidth ()
 
virtual void SetOrigin (const Vertex &vert)
 
virtual void Parent (DisplayFrame *par)
 
DisplayFrameParent () const
 
virtual void ParentGroup (Group *group)
 
GroupParentGroup () const
 
virtual DisplayObjectPick3D (const Vector &winLoc, const Vector &logicalCoords, float scale, const Vector &directionVector, Vector &collisionWinLoc, const OpenGLMatrices &drawnMatrices)
 
unsigned char Pickable ()
 
virtual void Pickable (unsigned char pick)
 
virtual int PolygonEnd ()
 
virtual void PolygonEnd (const int end)
 
virtual int PolygonMode ()
 
virtual void PolygonMode (int mode)
 
virtual void PreDraw (const OpenGLMatrices &current, Culler &culler)
 
GlsMatrixTypeProjMatrix ()
 
virtual void ReallocateVertices (unsigned int numVertices, bool initializeNew, bool copyOld)
 
virtual float RelativeAngle (const float x, const float y)
 
virtual DistiAttributeBaseResource (const char *name)
 
virtual void GetResources (std::ostream &outstr, GlsResourceFilter *filter=NULL)
 
void RestoreAlpha ()
 
void RestoreAntiAlias ()
 
void RestoreLighting ()
 
void RestoreLineStyle ()
 
const VertexRotationPoint () const
 
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)
 
virtual void Rotate (const Vector &orig, float angle, const Vector &axis)
 
void SaveMatrices ()
 
virtual void Scale (float px, float py, float pz, Vertex *anchor, int handleBar=0)
 
void Set (int spec,...)
 
bool SetupAlpha ()
 
bool SetupAntiAlias ()
 
void SetupDepthTest ()
 
void SetupLighting ()
 
bool SetupLineStyle ()
 
void SetupPolyDrawStyle ()
 
void SetupShading ()
 
bool SetupTexture ()
 
virtual int Shading ()
 
virtual void Shading (const int shading)
 
virtual void GetTransformedExtents (Vector &min, Vector &max, const GlsMatrixType &matrix, bool resetMinMax=true)
 
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 ()
 
VectorGetTextureCoordinates ()
 
virtual int TextureIndex ()
 
virtual void TextureIndex (int textureIndex)
 
virtual VectorGetTexturePoints ()
 
virtual bool TextureRepeat ()
 
virtual void TextureRepeat (const int rep)
 
virtual int TextureMappingTechnique ()
 
virtual void TextureMappingTechnique (const int map)
 
virtual int TextureMagnificationFilter ()
 
virtual void TextureMagnificationFilter (const int filter)
 
virtual int TextureMinificationFilter ()
 
virtual void TextureMinificationFilter (const int filter)
 
virtual void Translate (float tr[])
 
virtual void Translate (float x, float y, float z)
 
virtual void TranslateVertices (float x, float y, float z)
 
virtual void UpdateBoundingVolume ()
 
void * UserData () 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 () const
 
bool Visibility () const
 
virtual void Visibility (const bool vis)
 
virtual Vector WorldRotationPoint ()
 
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) override
 
virtual void SetPainter (GlsPainter *painter)
 
virtual GlsPainterGetPainter ()
 
void InvalidatePainter ()
 
virtual bool IsVisibleInScene (const DisplayObject *obj=NULL) const
 
- Public Member Functions inherited from AttributeChangedNotifier
virtual void NotifyAttributeChanged (const AttributeName &name)=0
 
virtual ~AttributeChangedNotifier ()
 
- 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
 

Static Public Member Functions

static DisplayObjectCreateInstance ()
 
- Static Public Member Functions inherited from Group
static DisplayObjectCreateInstance ()
 
- Static Public Member Functions inherited from DisplayObject
static InterfaceListTypeStaticGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)
 
static void UseManualBlinkElapsedTime (bool useManualTime)
 
static void SetManualBlinkElapsedTime (double elapsedTime)
 

Public Attributes

enum disti::GlsMultiView:: { ... }  ClearBackgroundEnum
 
- Public Attributes inherited from Group
DynamicArray< CompatabilityListItem_compatList
 Used for GL Studio 2.1 compatibility only.
 

Protected Member Functions

void CalculateViewMatrices (const OpenGLMatrices &parentMatrices, Culler &culler, GlsMultiView::ViewData *view) const
 
bool PreDrawGeometryForView (int viewNumber, ViewData *view)
 
void ReapplyGlobalLightsForView (ViewData *view)
 
- Protected Member Functions inherited from Group
virtual void AddAvailableAttributes (unsigned int availableAttributes)
 
virtual 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)
 
virtual int ColorMaterialMode ()
 
void AllocateModelMatrix ()
 
bool ApplyDynamicRotation ()
 
virtual void CalcDrawMatrix ()
 
void CalcDrawMatrixIfExists ()
 
virtual void CalculateMatrices (const OpenGLMatrices &newMatrices)
 
bool InsideVertexExtents (float x, float y, unsigned int nVerts, Vertex *verts, float tolerance)
 
void LastDrawMatrixLocation (const Vertex &loc)
 
const VertexLastDrawMatrixLocation ()
 
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)
 
virtual void SetValue (int spec, va_list &args)
 
int GetApplicableTextureIndex ()
 
int GetApplicableTextureRepeat ()
 
- Protected Member Functions inherited from WeakReferenceableMixin
 WeakReferenceableMixin ()
 
virtual ~WeakReferenceableMixin ()
 

Protected Attributes

ViewDrawStateEnum _viewDrawingState
 The drawing behavior for the multi view, generally VIEWS_ONLY.
 
ViewDataArray _viewArray
 The list of all views associated with this multi view.
 
ViewData _mainViewData
 The main (parent) view used for drawing geometry based views.
 
int _lastViewPicked
 The index of the last view picked, or -1 if the main view.
 
int _lastViewPredraw
 The index of the last view predraw or -1 if predraw used parent's view.
 
bool _showHighlights
 Used by the editor to turn on and off highlights.
 
int _highlightView
 Used by the editor to highlight a specific view. -1 is none.
 
bool _emitViewDrawEvents
 If true, will emit VIEW_DRAW_BEGIN / VIEW_DRAW_END object events on draw.
 
ComponentLightMgr_multiViewLightMgr
 Our very own light manager.
 
bool _childLightsAffectGlobal
 Calculated internally based on if geometry is drawn.
 
GlsMatrixType _savedProjectionMatrix
 Stores the projection matrix from PreDraw for restoring after DrawView.
 
- Protected Attributes inherited from Group
DisplayObjectArray _objects
 The objects contained in this group.
 
- Protected Attributes inherited from DisplayObject
int _alphaMode
 
bool _antiAlias
 
bool _attributesAdded
 
bool _blinking
 
float _blinkRate
 
GlsColor _color
 
bool _cullBackFace
 
GlsMatrixType _dcsMatrix
 
unsigned char _depthTest
 
GlsMatrixType_drawMatrix
 
bool _needCalcDrawMatrix
 True if CalcDrawMatrix() needs to be called on this object.
 
unsigned char _lineStippleMultiplier
 
unsigned short _lineStipplePattern
 
float _lineWidth
 
Vertex _location
 
DynamicArray< int > _materialIndices
 List of materials associated with this object.
 
GlsMatrixType_modelMatrix
 
Vector_normals
 
unsigned int _nTex_vertices
 
unsigned int _nVertices
 
unsigned char _polygonEnd
 
unsigned char _polygonMode
 
GlsMatrixType_projMatrix
 
unsigned char _shading
 
Vector_texCoord
 
GlsColor _textureBlendColor
 
int _textureIndex
 
unsigned char _textureMagFilter
 
unsigned char _textureMinFilter
 
unsigned char _textureMap
 
Vector _texturePoints [4]
 
unsigned char _textureRepeat
 
void * _userData
 
Vertex_vertices
 
int * _viewMatrix
 
bool _visible
 
- Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * _weakRefs
 

Friends

class GlsMultiViewEditor
 

Detailed Description

Runtime implementation of GlsMultiView

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

The ClearBackgroundEnum enumeration. Describes how the background for a given view will be cleared.

◆ ViewDrawStateEnum

The ViewDrawStateEnum enumeration. Describes the drawing behavior for the multi view.

Constructor & Destructor Documentation

◆ GlsMultiView() [1/2]

GlsMultiView ( int  generateInstance = FALSE)

Create a new GlsMultiView.

Parameters
generateInstanceWhether or not to generate an instance name for this inputdevice

◆ GlsMultiView() [2/2]

GlsMultiView ( const GlsMultiView that,
const bool  generateNames 
)

Copy constructor

Parameters
thatThe object to copy from.
generateNamesWhether or not to generate an instance name.

◆ ~GlsMultiView()

virtual ~GlsMultiView ( )
virtual

GlsMultiView deconstructor

Member Function Documentation

◆ CalculateViewMatrices()

void CalculateViewMatrices ( const OpenGLMatrices parentMatrices,
Culler culler,
GlsMultiView::ViewData view 
) const
protected

Calculate the matrices that are used for drawing the given view. This method is called during the PreDraw, then the matrices are used to setup the geometry for the Draw and Pick3D later.

Note
Not normally called by users.
Parameters
parentMatricesThe initial matrix state at the parent view.
cullerThe intial culler state at the parent view.
viewThe view to calculate matrices for.

◆ CloneObject()

virtual DisplayObject * CloneObject ( bool  generateNames = FALSE)
virtual

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.

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

Reimplemented from Group.

◆ CopyProperties()

virtual void CopyProperties ( DisplayObject src)
virtual

Copies the attributes except for geometry attributes from one object to another. Used by the undo mechanism to undo most attribute change operations.

Parameters
srcThe object to copy properties from

Reimplemented from Group.

◆ CreateInstance()

static DisplayObject * CreateInstance ( )
static
Returns
A pointer to a new GlsMultiView object.

◆ Draw()

virtual void Draw ( )
virtual

Draws this object on the current display frame (_parent member). Pure virtual method

Reimplemented from Group.

◆ DrawView()

void DrawView ( unsigned int  viewNumber,
ViewData view 
)

Draws the given view.

Note
Not normally called by users.
Parameters
viewNumberThe index of the view to draw.
viewThe view data of the view to draw.

◆ EmitViewDrawEvents() [1/2]

bool EmitViewDrawEvents ( ) const
Returns
The value for _emitViewDrawEvents.

◆ EmitViewDrawEvents() [2/2]

void EmitViewDrawEvents ( const bool &  )

Set the value for _emitViewDrawEvents When true, an object event is emitted at the start and end the draw of each view. VIEW_DRAW_BEGIN and VIEW_DRAW_END The data of the event is the view index.

These events are currently EXPERIMENTAL and may be removed or changed in a future release. They are not accessable from the plugin GUI for this reason.

◆ GetCppInterfaceDescription()

virtual InterfaceListType * GetCppInterfaceDescription ( InterfaceListType addToThisList = NULL)
virtual

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

Parameters
addToThisListIf not NULL this list will be added to then returned. If NULL a new list will be created.
Returns
A templated list.
The caller must call the corresponding free method to safely free the memory.

Reimplemented from Group.

◆ GetCppInterfaceDescriptionFree()

virtual void GetCppInterfaceDescriptionFree ( InterfaceListType array)
virtual

Frees the memory allocated by a previous call to GetCppInterfaceDescription

Parameters
arrayMemory allocated by a previous call to GetCppInterfaceDescription

Reimplemented from Group.

◆ GetResources()

virtual void GetResources ( std::ostream &  outstr,
GlsResourceFilter filter = NULL 
)
virtual

Writes the resources (attributes) of this object to the specified stream. The output of this method can be controlled by the GlsResourceFilter. Note that if filter->NamesOnly() is false (the default), then only resources that can return a value will appear in the list.

See also
GlsResourceFilter
DistiAttributeProperty
Parameters
outstrThe stream to write to
filterThe filter to determine what to write

Reimplemented from Group.

◆ handle()

virtual DisplayObject * handle ( DisplayEvent ev)
virtual

Handles an event that is sent to the object.

Parameters
evThe event to send to the object
Returns
Which object handled the event

Reimplemented from DisplayObject.

◆ LastViewPicked()

int LastViewPicked ( ) const

Return the integer id of the last view that was picked or -1 if no view has been picked yet or if the GlsMultiview was picked because it is set to PICK_ALWAYS.

Returns
The id of the last view that was picked.

◆ Pick3D()

virtual DisplayObject * Pick3D ( const Vector winLoc,
const Vector logicalCoords,
float  scale,
const Vector directionVector,
Vector collisionWinLoc,
const OpenGLMatrices drawnMatrices 
)
virtual

Attempts to pick an object in 3D and accounting for dynamic rotations and translations of this object or parent objects. It also looks at the pickable status and attempts to return the "Best" pick if that is what is desired.

Note: This method will pick objects in the scene based on a pick ray starting at winLoc and pointing into the screen. It will not pick objects behind the depth specified by winLoc.z. Typically winLoc.z should be set to 0 to ensure that the pick ray starts at near clip plane.

Parameters
winLocDevice coordinates for the mouse click. Z value should be set to 0 to ensure pick ray starts at near clip plane.
logicalCoordsThe start of the pick ray in logical coordinates. Should be calculated from the winLoc using this->WindowToLogical(winLoc, logicalCoords, &directionVector).
scaleCurrent window scale. Affects picking radius of outlines. Initial value should typically be 1.0.
directionVectorThe direction of the pick ray in logical coordinates. Should be calculated from the winLoc using this->WindowToLogical(winLoc, logicalCoords, &directionVector).
collisionWinLocReturns where the pick vector intersects the object that is hit in device coordinates.
drawnMatricesThe matrices used to draw the object, including matrices set by parents that may have dynamically rotated, translated or scaled this object. Initial value should typically be a default OpenGLMatrices() object.
Returns
The object that was hit, or NULL if no object hit

Reimplemented from Group.

◆ PreDraw()

virtual void PreDraw ( const OpenGLMatrices current,
Culler culler 
)
virtual

Traverses the hierarchy calculating the _modelMatrix, _projMatrix, _viewMatrix as needed.

Parameters
currentCurrent matrices inherited from parent
cullerObject that possibly marks this object for culling

Reimplemented from Group.

◆ PreDrawGeometryForView()

bool PreDrawGeometryForView ( int  viewNumber,
ViewData view 
)
protected

Applies the matrices for the given view to the geometry in preparation for a pick or draw.

Note
Not normally called by users.
Parameters
viewNumberThe number of the last view predraw or -1 if predraw used parent's view.
viewThe view data to predraw for.
Returns
True if the predraw was successful (view data is valid).

◆ ReapplyGlobalLightsForView()

void ReapplyGlobalLightsForView ( ViewData view)
protected

Forces a recalculation of parent lighting based on the current view.

Note
Not normally called by users.
Parameters
viewThe view to be used when calling ComponentLightMgr::ReapplyLightsForEyePoint().

◆ Resource()

virtual DistiAttributeBase & Resource ( const char *  name)
virtual

Gets a reference to the specified attribute for reading and writing. This reference can be streamed into and out of variables. For Example: someObject->Resource("Visible") >> someBool; someBool << someObject->Resource("Visible");

Parameters
nameThe name of the attribute to be returned.
Returns
A reference to the attribute if it is present, or DistiEmptyAttribute if not.

Reimplemented from DisplayObject.

◆ SetAvailableAttributes()

virtual void SetAvailableAttributes ( unsigned int  value)
virtual

Specifies which attributes are available for the object. Currently the available attributes cannot be changed after they have been set. (Only the first call has an effect.)

Parameters
valueA bitfield specifying which types of attributes to make available.
See also
AvailableAttributesEnum

Reimplemented from Group.

◆ SetValue()

virtual void SetValue ( int  spec,
va_list &  args 
)
virtual

Sets an attribute of this object using variable arguments

Parameters
specA GLS_Initializer tag
argsA variable argument list

Reimplemented from DisplayObject.

◆ View()

ViewData & View ( unsigned int  viewNumber)

Returns a reference to the specified View object Creates it (and all views with a lower id) if it doesn't exist

Parameters
viewNumberThe index of the view to return.
Returns
The associated view.

◆ ViewArray()

ViewDataArray & ViewArray ( )
Returns
A reference to the array containing the Views.

◆ ViewCount()

unsigned int ViewCount ( ) const

Returns the number of views

Returns
The view count

◆ ViewDrawingState()

ViewDrawStateEnum ViewDrawingState ( )
Returns
the ViewDrawingState

Member Data Documentation

◆ 

enum { ... } ClearBackgroundEnum

The ClearBackgroundEnum enumeration. Describes how the background for a given view will be cleared.


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