---

jsWRLtypes.h

Go to the documentation of this file.

/*
Copyright (C) 2002  Carsten Winkelholz / Pirros Tsiakoulis

Address:  FGAN Forschungsgesellschaft f�r Angewandte Naturwissenschaften e. V.
      Neuenahrer Str. 20
      D - 53343 Wachtberg
      
Email:    winkelholz@fgan.de

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

#ifndef JSWRLTYPES_HC
#define JSWRLTYPES_HC

#include "jsapi.h"
#include "../oawconfig.h"

OAW_BEGIN_NAMESPACE



//class for private data of javascript objects
class OAW_DLLMAPPING jsPrivate
{
public:
  //for simple objects
  long m_wrlType;     //the type of the object
  const void *m_pWrlData;   //pointer to the actual data (C++)
  short m_hasFlag;    //is eventOut
  void *m_pWrlFlag;   //pointer to the flag for eventOuts
  short m_MustDelete; //flag if the C++ data must be deleted 
                      //when javascript object is destroyed

  //for copies of SFNode fields
  long m_fieldId;       //the id of field or eventOut
  const SFNode *m_pNode;    //the node containing the field

  //for global object's private data
  CybWorldC* m_pWorld;
  CybSAI::BrowserC* m_pBrowser;
  CybScriptC* m_pScript;

  //for global object
  jsPrivate(CybWorldC* pW,CybSAI::BrowserC* pB,CybScriptC* pS)
  {
    m_pWorld = pW;
    m_pBrowser = pB;
    m_pScript = pS;
    m_MustDelete = 0;
  }

  jsPrivate(long type, const void *data, short hasF, void *flag, short mustDel, long id = -1, const SFNode *node = NULL)
  {
    m_wrlType = type;
    m_pWrlData = data;
    m_hasFlag = hasF;
    m_pWrlFlag = flag;
    m_MustDelete = mustDel;

    m_fieldId = id;
    m_pNode = node;
  }
  
  ~jsPrivate();
};

//enumerations for SFVec2f, SFVec3f, SFColor, SFRotation, SFImage properties
enum {SFVEC2F_X,SFVEC2F_Y};
enum {SFVEC3F_X,SFVEC3F_Y,SFVEC3F_Z};
enum {SFCOLOR_R,SFCOLOR_G,SFCOLOR_B};
enum {SFROTATION_X,SFROTATION_Y,SFROTATION_Z,SFROTATION_ANGLE};
enum {SFIMAGE_X,SFIMAGE_Y,SFIMAGE_COMP,SFIMAGE_ARRAY};

//javascript class descriptors for VRML data types
extern JSClass SFVec2f_class;
extern JSClass SFVec3f_class;
extern JSClass SFColor_class;
extern JSClass SFRotation_class;
extern JSClass SFNode_class;
extern JSClass SFImage_class;

extern JSClass MFInt32_class;
extern JSClass MFFloat_class;
extern JSClass MFVec2f_class;
extern JSClass MFVec3f_class;
extern JSClass MFRotation_class;
extern JSClass MFColor_class;
extern JSClass MFString_class;
extern JSClass MFNode_class;

/*initilizes all VRML javascript classes
    cx, obj context and global object*/
OAW_DLLMAPPING bool initJsWrlClasses(JSContext *cx, JSObject *obj);

/*constructs a new object and makes it global property or return it with rval
  cx, glob context and global object
  name the name of the global property 
  type the type of the ogject to create
  value the poiter to the actual C++ object or value
  flag the flag for eventOuts
  rval for returning the object if name = NULL
  fid and node for copies of SFNode fields
  mustdel flag if value should be deleted when object destroyed
  return value: on success 1, on error 0*/
OAW_DLLMAPPING short NewGlobalProperty(JSContext *cx,JSObject *glob,const char *name, long type, void *value, void *flag, jsval *rval, long fid = -1, SFNode *node = NULL, short mustDel = 0);

/*checks if simple eventOut has change and copies the new value
  type the type of the eventOut
  name the name of the eventOut
  dest the destination to copy the new data
  return value: on success 1, on error 0*/
void CopyJSWrlData(JSContext *cx, JSObject *obj, long type, const char *name, void *dest);
void WriteJSWrlData(JSContext *cx, JSObject *obj, long type, const char *name, void *src);


/*returns the name of the SFNode node*/
OAW_DLLMAPPING const char *GetSFNodeName(const SFNode *node);

OAW_DLLMAPPING bool initBrowserObject(JSContext *cx, JSObject *obj);

OAW_DLLMAPPING bool initSFVec2fClass(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initSFVec3fClass(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initSFColorClass(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initSFRotationClass(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initSFNodeClass(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initSFImageClass(JSContext *cx, JSObject *obj);

OAW_DLLMAPPING bool initMFInt32Class(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initMFFloatClass(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initMFVec2fClass(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initMFVec3fClass(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initMFRotationClass(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initMFColorClass(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initMFNodeClass(JSContext *cx, JSObject *obj);
OAW_DLLMAPPING bool initMFStringClass(JSContext *cx, JSObject *obj);


OAW_END_NAMESPACE


#endif

---