GL Studio C++ Runtime API
GlsRSOWrapper Class Reference

#include <gls_rso_wrapper.h>

Inheritance diagram for GlsRSOWrapper:
ComponentBase RSOInterface5::RSOPainter Group DisplayFrame DisplayObject AttributeChangedNotifier WeakReferenceableMixin AttributeChangedNotifier WeakReferenceableMixin WeakReferenceable WeakReferenceable

Public Member Functions

 GlsRSOWrapper (RsoImplBaseInterface *rso, unsigned int RSOVersion)
 
virtual ~GlsRSOWrapper ()
 
virtual void DeleteInstance ()
 
void ChangeRSO (RsoImplBaseInterface *rso, bool deleteCurrent=true)
 
RsoImplBaseInterfaceRSOInterface ()
 
unsigned int GetRSOVersion () const
 
int HandleEmittedEvent (RsoImplBaseInterface::Event *ev)
 
const char * LastEmittedEventInitiatorName () const
 
virtual void AlphaMode (int mode)
 
virtual int AlphaMode (void)
 
virtual void AntiAlias (bool alias)
 
virtual bool AntiAlias (void)
 
virtual void SetBlendColor (const GlsColor &color)
 
virtual GlsColor GetBlendColor ()
 
virtual GlsColor GetColor ()
 
virtual void SetColor (const GlsColor &color)
 
virtual void CullBackFace (const bool val)
 
virtual bool CullBackFace (void)
 
virtual int DepthTest (void)
 
virtual bool LightingEnabled ()
 
virtual void LightingEnabled (bool lighting)
 
virtual int LineStippleMultiplier (void)
 
virtual void LineStippleMultiplier (int mult)
 
virtual int LineStipplePattern (void)
 
virtual void LineStipplePattern (int pattern)
 
virtual float LineWidth (void)
 
virtual void LineWidth (float width)
 
virtual int MaterialIndex ()
 
virtual int PolygonMode (void)
 
virtual void PolygonMode (int mode)
 
virtual int PolygonEnd (void)
 
virtual void PolygonEnd (const int end)
 
virtual int Shading (void)
 
virtual void Shading (const int shading)
 
virtual int TextureIndex (void)
 
virtual void TextureIndex (int textureIndex)
 
virtual bool TextureRepeat (void)
 
virtual void TextureRepeat (const int rep)
 
virtual int TextureMappingTechnique (void)
 
virtual void TextureMappingTechnique (const int map)
 
virtual int TextureMagnificationFilter (void)
 
virtual void TextureMagnificationFilter (const int filter)
 
virtual int TextureMinificationFilter (void)
 
virtual void TextureMinificationFilter (const int filter)
 
virtual void AbsolutePlacement (bool filter)
 
virtual void Calculate (double time)
 
virtual DisplayObjectCloneObject (bool generateNames=false)
 
virtual void CopyGeometry (DisplayObject *src)
 
virtual void CopyProperties (DisplayObject *src)
 
virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)
 
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array)
 
virtual void CreateObjects ()
 
virtual void Draw ()
 
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 DisplayObjecthandle (DisplayEvent *ev)
 
virtual DisplayObjectHandleInput (DisplayEvent *ev)
 
virtual void Init ()
 
virtual void Initialize ()
 
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 UpdateBoundingVolume (void)
 
void SetValue (int spec, va_list &args)
 
virtual void Invalidate () override
 
virtual void SetPainter (GlsPainter *painter) override
 
- Public Member Functions inherited from ComponentBase
 ComponentBase (int generateInstance=0)
 
virtual ~ComponentBase ()
 
virtual void SetAvailableAttributes (unsigned int value)
 
bool AbsolutePlacement () const
 
virtual void ClearDragAndFocus ()
 
virtual void DeleteAllChildren ()
 
virtual DisplayObjectFindByNameSameFrame (const char *name)
 
LiveComponentAccessorLiveAccessor ()
 
virtual const VertexLocation (void) const override
 
virtual void Location (const Vertex &v) override
 
virtual void Location (float x, float y, float z)
 
virtual void Parent (DisplayFrame *par)
 
DisplayFrameParentDisplayFrame () const
 
void ParentDisplayFrame (DisplayFrame *val)
 
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 InputHandlerGetInputHandler ()
 
void NotifyAttributeChanged (const AttributeName &name) override
 
- Public Member Functions inherited from Group
DisplayObjectFindByName (const char *name)
 
DisplayObjectFindByName (DisplayObject *obj)
 
DisplayObjectFindByQualifiedName (const char *name)
 
DisplayObjectFindNonRecursive (DisplayObject *obj)
 
DisplayObjectArrayObjects ()
 
const DisplayObjectArrayObjects () const
 
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)
 
const DisplayObjectoperator[] (unsigned int index) const
 
DisplayObjectFirstObject ()
 
DisplayObjectLastObject (void)
 
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 bool Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint)
 
void SetPainter (GlsPainter *painter) override
 
virtual void TranslateVertices (float x, float y, float z)
 
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 CalculateTextureCoordinates (void) override
 
virtual void DepthTest (unsigned char mode) override
 
virtual void SetFillColor (const GlsColor &color)
 
virtual GlsColor GetFillColor (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)
 
virtual void DeleteVertexAt (unsigned int index)
 
virtual void DeleteVertex (unsigned int indexAfter) final
 
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 void GenerateInstanceName (void)
 
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 (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 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 () 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)
 
void SaveMatrices ()
 
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)
 
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) override
 
virtual GlsPainterGetPainter ()
 
void InvalidatePainter ()
 
virtual bool IsVisibleInScene (const DisplayObject *obj=NULL) const
 
- Public Member Functions inherited from AttributeChangedNotifier
virtual ~AttributeChangedNotifier ()
 
- Public Member Functions inherited from WeakReferenceableMixin
void AddWeakReference (WeakReference *weakRef) override
 
void NotifyWeakReferenceDestroyed (WeakReference *ref) override
 
- 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)
 

Static Public Member Functions

static GlsRSOWrapperCreateInstance (RsoImplBaseInterface *rso, unsigned int RSOVersion)
 
- 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)
 

Protected Types

enum  MultitouchState
 

Protected Member Functions

virtual DisplayObjectHandleMultiTouchInput (MouseEvent *mev)
 
- 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)
 
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)
 
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)
 

Additional Inherited Members

- Public Types inherited from DisplayObject
enum  AvailableAttributesEnum
 
- Public Attributes inherited from DisplayFrame
TexturePalettetexturePalette
 
SoundSystem_sound_player
 
Groupobjects
 
- Protected Attributes inherited from ComponentBase
LiveComponentAccessor_liveAccessor
 
bool _absolutePlacement
 
DisplayFrame_parentDisplayFrame
 
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
 
GlsMatrixType_drawMatrix
 
unsigned char _lineStippleMultiplier
 
unsigned short _lineStipplePattern
 
float _lineWidth
 
Vertex _location
 
GlsMatrixType_modelMatrix
 
Vector_normals
 
unsigned int _nTex_vertices
 
unsigned int _nVertices
 
unsigned char _polygonEnd
 
unsigned char _polygonMode
 
int _polygonOffset
 
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
 
- Protected Attributes inherited from DisplayFrame
bool _cullingEnabled
 
int _width
 
int _height
 
float _lastPickedDepth
 
DynamicMaterialArray _materialPalette
 
ComponentLightMgr_lightMgr
 
GLbitfield _clearBitfield
 
std::string _componentHeaderFileName
 
unsigned int _currentCursor
 
bool _multitouchEnabled
 
unsigned int _cursorsDown
 

Detailed Description

The GlsRSOWrapper class wraps an RsoImplBaseInterface object so that it can be inserted into the GL Studio heirarchy.

Member Enumeration Documentation

enum MultitouchState
protected

enum that guides the state machine for multitouch handling for RSO's that don't support multitouch. An RSO starts in the READY_FOR_INPUT state. When it handles a mouse drag event, it moves to PROCESSING_MOUSE_DRAG state. It will ignore any other mouse events if they are not for the original cursor_id. Then, once the RSO either receives the MOUSE_UP event or stops handling the MOUSE_DRAG events, the RSO then transitions to WAITING_FOR_MOUSE_DOWN (i.e. it keeps ignoring other cursors that might have been dragging on it while it was processing its original cursor event). Once it receives a new mouse down, it transitions back to READY_FOR_INPUT

Constructor & Destructor Documentation

GlsRSOWrapper ( RsoImplBaseInterface rso,
unsigned int  RSOVersion 
)

Constructor

Parameters
rsoThe RSO to wrap
RSOVersionthe highest RSOInterface the RSO supports (e.g. 1,2,3)
virtual ~GlsRSOWrapper ( )
virtual

Destructor Don't call "delete yourComponent;", instead call "yourComponent->Destroy();" to ensure that the object is deleted correctly.

Member Function Documentation

virtual void AbsolutePlacement ( bool  val)
virtual

Sets the value for Absolute Placement. This affects what happens durring the call to CreateObjects(). If true, the component will be left in the generated location. Otherwise it will be moved based on its extents

Reimplemented from ComponentBase.

virtual void AlphaMode ( int  mode)
virtual

Set the alpha mode state for this object

Parameters
modewhich alpha mode to use when drawing
See also
AlphaMode_e

Reimplemented from Group.

virtual int AlphaMode ( void  )
virtual

Get the alpha mode for this object

Returns
Whether or not alpha testing or blending is enabled when drawing
See also
AlphaMode_e

Reimplemented from Group.

virtual void AntiAlias ( bool  alias)
virtual

Set the anti aliasing state for this object

Parameters
aliasWhether or not to perform anti aliasing

Reimplemented from Group.

virtual bool AntiAlias ( void  )
virtual

Get the anti aliasing state this object

Returns
Whether or not this object will be drawn antialiased

Reimplemented from Group.

virtual void Calculate ( double  time)
virtual

Call the Calculate method for all children

Parameters
timeThe current time

Reimplemented from Group.

void ChangeRSO ( RsoImplBaseInterface rso,
bool  deleteCurrent = true 
)

Replace the RSO that the GlsRSOWrapper is wrapping.

Parameters
rsoThe new RSO to use
deleteCurrentWhether to delete the currently referenced rso. If false, then the caller is responsible for deleting it.
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 ComponentBase.

virtual void CopyGeometry ( DisplayObject src)
virtual

Copies the geometry information from one object to another. Used by the undo mechanism to allow user to undo a geometry change.

Parameters
srcThe object to copy geometry from

Reimplemented from ComponentBase.

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 ComponentBase.

static GlsRSOWrapper* CreateInstance ( RsoImplBaseInterface rso,
unsigned int  RSOVersion 
)
static

Call CreateInstance() and Destroy() instead of new and delete in a mixed-library environment to ensure that matching new and delete operators are called.

Parameters
rsoThe RSO to wrap
RSOVersionthe highest RSOInterface the RSO supports (e.g. 1,2,3)
virtual void CreateObjects ( )
virtual

In derived classes this creates all the geometry for the component

Reimplemented from ComponentBase.

virtual void CullBackFace ( const bool  val)
virtual

Sets if back faces should be removed

Parameters
valTrue if back faces should be removed

Reimplemented from Group.

virtual bool CullBackFace ( void  )
virtual

Returns if back faces should be removed

Returns
True if backfaces are removed

Reimplemented from Group.

virtual void DeleteInstance ( )
virtual

Utility Method: Users should call Destroy() instead. Safely delete an object that was created using CreateInstance.

virtual int DepthTest ( void  )
virtual

Get the z buffering state for this object

Returns
Whether or not this object will be draw Z buffered

Reimplemented from Group.

virtual void Draw ( )
virtual

Draws this object and all its contained objects in the current OpenGL pipeline. This can be overloaded to perform any special effects. If PreDraw and Draw are needed, call DisplayFrame::Draw()

Reimplemented from ComponentBase.

virtual GlsColor GetBlendColor ( )
virtual

Gets the texture blend color for the object

Returns
Returns the current texture blend color.

Reimplemented from Group.

virtual GlsColor GetColor ( )
virtual

Gets the color for the object outline

Returns
The outline color

Reimplemented from Group.

virtual InterfaceListType* GetCppInterfaceDescription ( InterfaceListType addToThisList = NULL)
virtual

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

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

Reimplemented from ComponentBase.

virtual void GetCppInterfaceDescriptionFree ( InterfaceListType array)
virtual

Frees the memory allocated by a previous GetCppInterfaceDescription call

Parameters
arrayPointer to memory allocated by GetCppInterfaceDescription

Reimplemented from ComponentBase.

virtual void GetExtents ( float &  x,
float &  y,
float &  z,
float &  x1,
float &  y1,
float &  z1 
)
virtual

Figure out the static extents for the object. Used by the editor as part of the pick operation and for figuring out the size of groups.

Parameters
xGets the minimum x extent
yGets the minimum y extent
zGets the minimum z extent
x1Gets the maximum x extent
y1Gets the maximum y extent
z1Gets the maximum z extent

Reimplemented from ComponentBase.

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

Get the resources for this display frame and all it's children acording to the filter

Parameters
outstrThe stream to write to
filterThe filter to control what gets written.

Reimplemented from ComponentBase.

unsigned int GetRSOVersion ( ) const
inline

Returns the rso version

virtual void GetTransformedExtents ( Vector min,
Vector max,
const GlsMatrixType matrix,
bool  resetMinMax = true 
)
virtual

Determines the extents of geometry projected to the XY plane of an arbirary coordinate system.

Parameters
minReturns the minimum values found in the traversal
maxReturns the maximum values found in the traversal
matrixTransformation matrix from world coordinates to the desired coordinate system.
resetMinMaxNormally not specified by user. Should be true for the initial call.

Reimplemented from ComponentBase.

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.

int HandleEmittedEvent ( RsoImplBaseInterface::Event ev)

Handle an event that was emitted from the RSO.

virtual DisplayObject* HandleInput ( DisplayEvent ev)
virtual

Handles input events. It traverses the hierarchy with Pick3D. Then THE picked object is given the handle() call.

Parameters
evThe event data.
Returns
The object that handled the input.

Reimplemented from ComponentBase.

virtual DisplayObject* HandleMultiTouchInput ( MouseEvent mev)
protectedvirtual

this function should be called to handle mouse events if the RSO handles multitouch (RSO version 3 or greater)

virtual void Init ( )
virtual

Peforms post creation tasks including reparenting all objects. and adjusting their position. It checks the value of _absolutePlacement to determine if movement of the generated objects is necessary /see AbsolutePlacement

Reimplemented from ComponentBase.

virtual void Initialize ( )
virtual

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.

virtual void Invalidate ( )
overridevirtual

Calls Invalidate on the parent's painter, causing the scene to redraw in conditional rendering.

Implements RSOInterface5::RSOPainter.

const char* LastEmittedEventInitiatorName ( ) const

Returns the qualified instance name of the initiator of the last event that was passed to HandleEmittedEvent or "" if no events have been passed to HandleEmittedEvent.

virtual bool LightingEnabled ( )
virtual

Gets the lighting state

Reimplemented from Group.

virtual void LightingEnabled ( bool  lighting)
virtual

Sets the lighting state

Reimplemented from Group.

virtual int LineStippleMultiplier ( void  )
virtual

Get the line stipple multiplier for this object

Returns
The line stipple multiplier for this object

Reimplemented from Group.

virtual void LineStippleMultiplier ( int  mult)
virtual

Set the line stipple multiplier for this object

Parameters
multThe new line stipple pattern

Reimplemented from Group.

virtual int LineStipplePattern ( void  )
virtual

Get the line stipple pattern for this object

Returns
The line stipple pattern for this object

Reimplemented from Group.

virtual void LineStipplePattern ( int  pattern)
virtual

Set the line stipple pattern for this object

Parameters
patternThe new line stipple pattern

Reimplemented from Group.

virtual float LineWidth ( void  )
virtual

Gets the width of lines in the object.

Returns
The line width of the object in logical units

Reimplemented from Group.

virtual void LineWidth ( float  width)
virtual

Sets the width of lines in the object.

Parameters
widthThe new line width of the object in logical units

Reimplemented from Group.

virtual int MaterialIndex ( )
virtual

Gets material index. Returns -1 if multiple are applied.

Reimplemented from DisplayObject.

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 ComponentBase.

virtual int PolygonEnd ( void  )
virtual

Gets the polygon end mode (Open or Closed) for the polygon

Returns
Enumeration indicating open or closed mode
See also
PolygonClose_e

Reimplemented from Group.

virtual void PolygonEnd ( const int  end)
virtual

Sets the polygon end mode (Open or Closed) for the polygon

Parameters
endEnumeration indicating open or closed mode
See also
PolygonClose_e

Reimplemented from Group.

virtual int PolygonMode ( void  )
virtual

Gets the polygon drawing mode for this object

Returns
The polygon drawing mode for this object
See also
PolygonMode_e

Reimplemented from Group.

virtual void PolygonMode ( int  mode)
virtual

Sets the polygon drawing mode for this object

Parameters
modeThe new polygon drawing mode for this object
See also
PolygonMode_e

Reimplemented from Group.

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 ComponentBase.

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. This can access different levels of objects. For example: The DisplayFrame: Resource("ComponentHeaderFile") >> someStdString; An object in the DisplayFrame: Resource("SomeObject.Visible") << someBool; An object in a Component in this DisplayFrame: Resource("SomeComponentObject.SomeObject.Visible") >> someBool;

Reimplemented from ComponentBase.

RsoImplBaseInterface* RSOInterface ( )

Returns the current RSOInterface object

virtual void SetBlendColor ( const GlsColor color)
virtual

Sets the texture blend color for the object

Parameters
colorA GlsColor

Reimplemented from Group.

virtual void SetColor ( const GlsColor color)
virtual

Sets the RGBA color for the object outline

Parameters
colorThe new color

Reimplemented from Group.

virtual void SetPainter ( GlsPainter painter)
overridevirtual

Assigns a parent painter to this RSO which will be updated when any RSO child object causes invalidation.

Reimplemented from DisplayObject.

void SetValue ( int  spec,
va_list &  args 
)
virtual

Called on initial creation to set variables

Reimplemented from ComponentBase.

virtual int Shading ( void  )
virtual

Gets the polygon shading mode (Flat or gouraud) for the polygon

Returns
Enumeration indicating shading mode
See also
ShadingType_e

Reimplemented from Group.

virtual void Shading ( const int  shading)
virtual

Sets the polygon shading mode (Flat or gouraud) for the polygon

Parameters
shadingEnumeration indicating shading mode
See also
ShadingType_e

Reimplemented from Group.

virtual int TextureIndex ( void  )
virtual

Overridden so we will always get -1 for our texture index. This keeps our children from trying to draw with our texture index which would be for the wrong palette.

Reimplemented from ComponentBase.

virtual void TextureIndex ( int  textureIndex)
virtual

Sets the texture index to be used when drawing the object.

Parameters
textureIndexThe texture index to use. -1 indicates that no texture will be drawn.

Reimplemented from ComponentBase.

virtual int TextureMagnificationFilter ( void  )
virtual

Gets the texture magnification filter for this object

Returns
The texture magnification filter for this object
See also
TextureFilter_e

Reimplemented from Group.

virtual void TextureMagnificationFilter ( const int  filter)
virtual

Sets the texture magnification filter for this object

Parameters
filterThe new texture magnification filter for this object
See also
TextureFilter_e

Reimplemented from Group.

virtual int TextureMappingTechnique ( void  )
virtual

Gets the texturing mapping mode for this object

Returns
The texture mapping mode for this object
See also
TextureMap_e

Reimplemented from Group.

virtual void TextureMappingTechnique ( const int  map)
virtual

Sets the texturing mapping mode for this object

Parameters
mapThe new texture mapping mode for this object
See also
TextureMap_e

Reimplemented from Group.

virtual int TextureMinificationFilter ( void  )
virtual

Gets the texture minification filter for this object

Returns
The texture minification filter for this object
See also
TextureFilter_e

Reimplemented from Group.

virtual void TextureMinificationFilter ( const int  filter)
virtual

Sets the texture minification filter for this object

Parameters
filterThe new texture minification filter for this object
See also
TextureFilter_e

Reimplemented from Group.

virtual bool TextureRepeat ( void  )
virtual

Gets the texturing repeat mode for this object

Returns
The texture repeat mode for this object

Reimplemented from DisplayObject.

virtual void TextureRepeat ( const int  rep)
virtual

Sets the texturing repeat mode for this object

Parameters
repThe new texture repeat mode for this object (boolean)

Reimplemented from Group.

virtual void UpdateBoundingVolume ( void  )
virtual

Updates the bounding volume of this object This method should be called if the vertices change for picking and culling to work correctly. This will only update this object. If PerformGroupCullCheck is enabled for one of the objects parents, you may also need to call CalculateParentBoundingBox() to update all of the objects parents.

Reimplemented from DisplayObject.


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