Callisto function reference  5.2
callisto52.h
Go to the documentation of this file.
1 #pragma once
2 
3 // include the types
4 #include "callisto52Types.h"
5 
6 // the resulting manual of this file can be found at http://www.nieuwenhuisen.nl/callisto/docs/html/index.html
7 
48 int CAL_Initialisation (bool visualisation=true, char *logFile=CAL_NULL, char *visLogFile=CAL_NULL);
49 
54 int CAL_End ();
55 
62 
68 
77 int CAL_ShowView (int viewID, char* caption="", bool maximized=false);
78 
85 int CAL_HideView (int viewID);
86 
91 int CAL_TileViews ();
92 
99 int CAL_SetViewOptions (int viewID, long options);
100 
105 int CAL_SetLightOptions (long options);
106 
113 
120 int CAL_SetViewNavigationSpeed (int viewID, CAL_scalar dist);
121 
128 int CAL_SetViewNearClippingDistance (int viewID, CAL_scalar dist);
129 
136 int CAL_SetViewGridSize (int viewID, CAL_scalar size);
137 
147 int CAL_SetCameraPosition (int viewID, CAL_scalar x, CAL_scalar y, CAL_scalar z, CAL_scalar time=-1);
148 
158 int CAL_SetCameraLookAt (int viewID, CAL_scalar x, CAL_scalar y, CAL_scalar z, CAL_scalar time=-1);
159 
167 int CAL_SetCameraRoll (int viewID, CAL_scalar roll, CAL_scalar time=-1);
168 
177 int CAL_SetCameraState (int viewID, CAL_scalar pos[3], CAL_scalar lookAt[3], CAL_scalar up[3], CAL_scalar time=-1);
178 
187 int CAL_GetCameraPosition (int viewID, CAL_scalar *x, CAL_scalar *y, CAL_scalar *z);
188 
197 int CAL_GetCameraLookAt (int viewID, CAL_scalar *x, CAL_scalar *y, CAL_scalar *z);
198 
205 int CAL_GetCameraRoll (int viewID, CAL_scalar *roll);
206 
212 int CAL_ClearCameraStates (int viewID);
213 
220 int CAL_SetCameraOptions (int viewID, long options);
221 
230 int CAL_SetBackgroundColor (int viewID, CAL_scalar red, CAL_scalar green, CAL_scalar blue);
231 
236 int CAL_AddTextureResource (char* pathName);
237 
244 int CAL_LoadTexture (int textureID, char* fileName);
245 
254 int CAL_SetTextureFromMem (int textureID, int width, int height, unsigned char *tex);
255 
262 int CAL_ScreenCapture (int viewID, char* fileName);
263 
272 int CAL_LoadScene (char* fileName, int parentID, bool eraseCurrent, char *&error);
273 
280 int CAL_SaveScene (char* fileName, int groupID);
281 
287 int CAL_SetTime (CAL_scalar time);
288 
298 int CAL_CreateGroup (int* groupID, int parentID, bool colCheck, char* name="", bool collapsed=false);
299 
305 int CAL_DestroyGroup (int groupID);
306 
313 int CAL_EmptyGroup (int groupID, bool subGroups=false);
314 
321 int CAL_MoveGroup (int groupID, int parentID);
322 
332 int CAL_SetGroupPosition (int groupID, CAL_scalar x, CAL_scalar y, CAL_scalar z, CAL_scalar time=-1);
333 
342 int CAL_SetGroupOrientationEuler (int groupID, CAL_scalar xRot, CAL_scalar yRot, CAL_scalar zRot, CAL_scalar time=-1);
343 
355 
363 int CAL_SetGroupOrientationMatrix (int groupID, CAL_matrix3 mat, CAL_scalar time=-1);
364 
374 int CAL_SetGroupScaling (int groupID, CAL_scalar xScale, CAL_scalar yScale, CAL_scalar zScale, CAL_scalar time=-1);
375 
384 int CAL_SetGroupVisibility (int groupID, int viewID, bool visible, CAL_scalar time=-1);
385 
392 int CAL_ClearGroupPositions (int groupID, bool subGroups=false);
393 
400 int CAL_ClearGroupOrientations (int groupID, bool subGroups=false);
401 
408 int CAL_ClearGroupScalings (int groupID, bool subGroups=false);
409 
416 int CAL_ClearGroupVisibilities (int groupID, bool subGroups=false);
417 
425 int CAL_SetGroupClearance (int groupID, CAL_scalar c);
426 
439 int CAL_SetGroupColor (int groupID, CAL_scalar red, CAL_scalar green, CAL_scalar blue, CAL_scalar alpha=1, bool receiveShadows=true, bool subGroups=false, int sID=0);
440 
453 int CAL_SetGroupTexture (int groupID, int textureID, CAL_scalar xtile, CAL_scalar ytile, CAL_scalar alpha=1, bool receiveShadows=true, bool subGroups=false, int sID=0);
454 
463 int CAL_SetGroupCastShadows (int groupID, bool castShadows, bool subGroups=false);
464 
471 int CAL_SetGroupActiveMaterial (int groupID, bool subGroups, int sID);
472 
480 int CAL_SetGroupCollisionCheckCapability (int groupID, bool colCapable, bool subGroups=false);
481 
487 int CAL_SetGroupName (int groupID, char *name);
488 
495 int CAL_SetGroupOptions (int groupID, long options);
496 
507 int CAL_CloneGroup (int* groupIDNew, int groupID, int parentID, bool colCheck, char* name="", bool cloneObjs=true);
508 
521 int CAL_CloneGroupRecursive (int* newgroupIDs, int groupID, int parentID, int nr, int* ids, char** names=CAL_NULL, bool cloneObjs=true, bool keepColCap=false);
522 
529 int CAL_MoveObject (int objID, int groupID);
530 
536 int CAL_DestroyObject (int objID);
537 
547 int CAL_SetObjectPosition (int objID, CAL_scalar x, CAL_scalar y, CAL_scalar z, CAL_scalar time=-1);
548 
558 int CAL_SetObjectOrientationEuler (int objID, CAL_scalar xRot, CAL_scalar yRot, CAL_scalar zRot, CAL_scalar time=-1);
559 
571 
579 int CAL_SetObjectOrientationMatrix (int objID, CAL_matrix3 mat, CAL_scalar time=-1);
580 
590 int CAL_SetObjectScaling (int objID, CAL_scalar xScale, CAL_scalar yScale, CAL_scalar zScale, CAL_scalar time=-1);
591 
600 int CAL_SetObjectVisibility (int objID, int viewID, bool visible, CAL_scalar time=-1);
601 
607 int CAL_ClearObjectPositions (int objID);
608 
614 int CAL_ClearObjectOrientations (int objID);
615 
621 int CAL_ClearObjectScalings (int objID);
622 
628 int CAL_ClearObjectVisibilities (int objID);
629 
637 int CAL_SetObjectWorldMatrix (int objID, CAL_matrix4 *matrix, CAL_scalar time);
638 
646 int CAL_SetObjectClearance (int objID, CAL_scalar clearance);
647 
659 int CAL_SetObjectColor (int objID, CAL_scalar red, CAL_scalar green, CAL_scalar blue, CAL_scalar alpha=1, bool receiveShadows=true, int sID=0);
660 
672 int CAL_SetObjectTexture (int objID, int textureID, CAL_scalar xtile, CAL_scalar ytile, CAL_scalar alpha=1, bool receiveShadows=true, int sID=0);
673 
681 int CAL_SetObjectCastShadows (int objID, bool castShadows);
682 
688 int CAL_SetObjectActiveMaterial (int objID, int sID);
689 
696 int CAL_SetObjectOptions (int objID, long options);
697 
704 int CAL_GetID (int* ID, char* name);
705 
712 int CAL_GetGroup (int groupID, void *CALGroup);
713 
721 int CAL_GetGroupChildID (int groupID, int nr, int *childGroupID);
722 
730 int CAL_GetGroupObjectID (int groupID, int nr, int *objectID);
731 
738 int CAL_GetObjectType (int objID, int* objType);
739 
746 int CAL_GetObjectWorldMatrix (int objID, CAL_matrix4 *matrix);
747 
755 int CAL_GetObject (int objID, void* SCALObj);
756 
763 
770 
781 int CAL_CreateBox (int groupID, CAL_scalar xw, CAL_scalar yw, CAL_scalar zw, int* objID=CAL_NULL, char* name="");
782 
791 int CAL_CreateSphere (int groupID, CAL_scalar radius, int* objID=CAL_NULL, char* name="");
792 
802 int CAL_CreateCylinder (int groupID, CAL_scalar radius, CAL_scalar height, int* objID=CAL_NULL, char* name="");
803 
814 int CAL_CreateCylinderFromTo (int groupID, CAL_scalar *from, CAL_scalar *to, CAL_scalar radius, int* objID=CAL_NULL, char* name="");
815 
825 int CAL_CreateCone (int groupID, CAL_scalar radius, CAL_scalar height, int* objID=CAL_NULL, char* name="");
826 
837 int CAL_CreateConeFromTo (int groupID, CAL_scalar *from, CAL_scalar *to, CAL_scalar radius, int* objID=CAL_NULL, char* name="");
838 
850 int CAL_CreateTriangles (int groupID, int nrTriangles, CAL_scalar* p, CAL_scalar* texCoords=CAL_NULL, int* objID=CAL_NULL, char* name="");
851 
862 int CAL_CreatePolyline (int groupID, int nl, int *np, CAL_scalar *p, int* objID=CAL_NULL, char* name="");
863 
873 int CAL_CreateTetrahedron (int groupID, CAL_scalar* p, int* objID=CAL_NULL, char* name="");
874 
887 int CAL_CreateElevationGrid (int groupID, int xDim, int zDim, CAL_scalar xStep, CAL_scalar zStep, CAL_scalar* heights, int *objID=CAL_NULL, char* name="");
888 
899 int CAL_CreatePointCloud (int groupID, int nrPoints, CAL_scalar *points, CAL_scalar *colors=CAL_NULL, int *objID=CAL_NULL, char* name="");
900 
913 int CAL_CreateLabel (int objID, char *caption, CAL_scalar charHeight, CAL_scalar x, CAL_scalar y, CAL_scalar z, bool showLine=true, bool fixedSize=false);
914 
921 int CAL_SetLabelCaption (int objID, char *caption);
922 
932 int CAL_SetLabelColor (int objID, CAL_scalar red, CAL_scalar green, CAL_scalar blue, CAL_scalar alpha);
933 
939 int CAL_DestroyLabel (int objID);
940 
954 int CAL_CreateOverlay (int *overlayID, int viewID, int xPos, int yPos, int xDim, int yDim, int referencePos=CAL_TOPLEFT, int nrLines=1, bool background=true);
955 
960 int CAL_DestroyOverlay (int overlayID);
961 
974 int CAL_SetOverlayTextLine (int overlayID, int lineNr, char *text, float charHeight=10.f, float red=1.0f, float green=1.0f, float blue=1.0f, float alpha=1.0f);
975 
981 int CAL_SetOverlayVisibility (int overlayID, bool visibility);
982 
993 int CAL_CheckPointCollision (int groupID, CAL_scalar x, CAL_scalar y, CAL_scalar z, bool multiple, int *nrCols);
994 
1008 int CAL_CheckLineCollision (int groupID, CAL_scalar x0, CAL_scalar y0, CAL_scalar z0, CAL_scalar x1, CAL_scalar y1, CAL_scalar z1, bool multiple, int *nrCols);
1009 
1018 int CAL_CheckGroupCollision (int group0, int group1, bool multiple, int *nrCols);
1019 
1027 int CAL_GetClosestPairs (int groupID0, int groupID1, int *nrPairs);
1028 
1036 int CAL_GetPenetrationDepths (int groupID0, int groupID1, int *nrPairs);
1037 
1043 int CAL_GetResults (void* userResults);
1044 
1049 int CAL_GatherStatistics (int enable);
1050 
1054 int CAL_ResetStatistics ();
1055 
1061 int CAL_SaveGroupStatistics (int groupID, char *fileName);
1062 
1067 int CAL_AddLogEntry (char *entry);
1068 
int CAL_DestroyOverlay(int overlayID)
int CAL_GetObject(int objID, void *SCALObj)
int CAL_SetTime(CAL_scalar time)
int CAL_MoveGroup(int groupID, int parentID)
int CAL_SetObjectPosition(int objID, CAL_scalar x, CAL_scalar y, CAL_scalar z, CAL_scalar time=-1)
int CAL_GetID(int *ID, char *name)
int CAL_SetKeypressCallback(CAL_KeypressCallback cb)
int CAL_CreateGroup(int *groupID, int parentID, bool colCheck, char *name="", bool collapsed=false)
int CAL_SetObjectScaling(int objID, CAL_scalar xScale, CAL_scalar yScale, CAL_scalar zScale, CAL_scalar time=-1)
int CAL_ShowView(int viewID, char *caption="", bool maximized=false)
CAL_scalar CAL_matrix3[3][3]
Definition: callisto52Types.h:14
int CAL_ClearGroupVisibilities(int groupID, bool subGroups=false)
int CAL_SetGroupCastShadows(int groupID, bool castShadows, bool subGroups=false)
int CAL_SetCameraRoll(int viewID, CAL_scalar roll, CAL_scalar time=-1)
int CAL_ResetStatistics()
int CAL_SetViewNearClippingDistance(int viewID, CAL_scalar dist)
int CAL_CreateOverlay(int *overlayID, int viewID, int xPos, int yPos, int xDim, int yDim, int referencePos=CAL_TOPLEFT, int nrLines=1, bool background=true)
int CAL_CreatePolyline(int groupID, int nl, int *np, CAL_scalar *p, int *objID=CAL_NULL, char *name="")
int CAL_SetGroupOrientationEuler(int groupID, CAL_scalar xRot, CAL_scalar yRot, CAL_scalar zRot, CAL_scalar time=-1)
int CAL_GetClosestPairs(int groupID0, int groupID1, int *nrPairs)
#define CAL_TOPLEFT
Definition: callisto52Types.h:223
int CAL_End()
int CAL_SetGroupClearance(int groupID, CAL_scalar c)
int CAL_GetObjectType(int objID, int *objType)
int CAL_GetGroupObjectID(int groupID, int nr, int *objectID)
int CAL_SetGroupOptions(int groupID, long options)
int CAL_SetCameraLookAt(int viewID, CAL_scalar x, CAL_scalar y, CAL_scalar z, CAL_scalar time=-1)
int CAL_ClearObjectVisibilities(int objID)
int CAL_SetGroupPosition(int groupID, CAL_scalar x, CAL_scalar y, CAL_scalar z, CAL_scalar time=-1)
int CAL_SetObjectWorldMatrix(int objID, CAL_matrix4 *matrix, CAL_scalar time)
int CAL_SetOverlayVisibility(int overlayID, bool visibility)
#define CAL_NULL
Definition: callisto52Types.h:23
int CAL_ClearGroupOrientations(int groupID, bool subGroups=false)
int CAL_AddLogEntry(char *entry)
int CAL_SetGroupTexture(int groupID, int textureID, CAL_scalar xtile, CAL_scalar ytile, CAL_scalar alpha=1, bool receiveShadows=true, bool subGroups=false, int sID=0)
int CAL_CreateLabel(int objID, char *caption, CAL_scalar charHeight, CAL_scalar x, CAL_scalar y, CAL_scalar z, bool showLine=true, bool fixedSize=false)
int CAL_SetViewNavigationSpeed(int viewID, CAL_scalar dist)
int CAL_CreateTriangles(int groupID, int nrTriangles, CAL_scalar *p, CAL_scalar *texCoords=CAL_NULL, int *objID=CAL_NULL, char *name="")
int CAL_AddTextureResource(char *pathName)
int CAL_HideView(int viewID)
int CAL_ClearCameraStates(int viewID)
int CAL_CreateCone(int groupID, CAL_scalar radius, CAL_scalar height, int *objID=CAL_NULL, char *name="")
int CAL_CreateCylinder(int groupID, CAL_scalar radius, CAL_scalar height, int *objID=CAL_NULL, char *name="")
int CAL_SetObjectOptions(int objID, long options)
int CAL_ClearGroupScalings(int groupID, bool subGroups=false)
int CAL_SetLightOptions(long options)
int CAL_GetCameraLookAt(int viewID, CAL_scalar *x, CAL_scalar *y, CAL_scalar *z)
int CAL_SetLabelColor(int objID, CAL_scalar red, CAL_scalar green, CAL_scalar blue, CAL_scalar alpha)
CAL_scalar CAL_matrix4[4][4]
Definition: callisto52Types.h:12
int CAL_DestroyGroup(int groupID)
int CAL_GetObjectWorldMatrix(int objID, CAL_matrix4 *matrix)
int CAL_LoadTexture(int textureID, char *fileName)
void(* CAL_ObjectSelectCallback)(int viewID, int objID, CAL_scalar hitPoint[3])
Definition: callisto52Types.h:20
int CAL_SetGroupOrientationMatrix(int groupID, CAL_matrix3 mat, CAL_scalar time=-1)
int CAL_SetViewOptions(int viewID, long options)
int CAL_GetGroupChildID(int groupID, int nr, int *childGroupID)
int CAL_SetViewGridSize(int viewID, CAL_scalar size)
int CAL_SetCameraPosition(int viewID, CAL_scalar x, CAL_scalar y, CAL_scalar z, CAL_scalar time=-1)
int CAL_SetViewFogDistance(CAL_scalar dist)
int CAL_CheckLineCollision(int groupID, CAL_scalar x0, CAL_scalar y0, CAL_scalar z0, CAL_scalar x1, CAL_scalar y1, CAL_scalar z1, bool multiple, int *nrCols)
Structures to retrieve data from Callisto.
int CAL_TileViews()
int CAL_EmptyGroup(int groupID, bool subGroups=false)
int CAL_SetObjectOrientationQuaternion(int objID, CAL_scalar x, CAL_scalar y, CAL_scalar z, CAL_scalar w, CAL_scalar time=-1)
int CAL_ScreenCapture(int viewID, char *fileName)
int CAL_SuspendVisualisation()
int CAL_SetObjectCastShadows(int objID, bool castShadows)
int CAL_MoveObject(int objID, int groupID)
int CAL_ClearGroupPositions(int groupID, bool subGroups=false)
int CAL_ClearObjectPositions(int objID)
int CAL_SetObjectOrientationEuler(int objID, CAL_scalar xRot, CAL_scalar yRot, CAL_scalar zRot, CAL_scalar time=-1)
int CAL_SetGroupName(int groupID, char *name)
int CAL_GetCameraPosition(int viewID, CAL_scalar *x, CAL_scalar *y, CAL_scalar *z)
int CAL_CreateSphere(int groupID, CAL_scalar radius, int *objID=CAL_NULL, char *name="")
void(* CAL_KeypressCallback)(int viewID, char key, bool pressed)
Definition: callisto52Types.h:17
int CAL_SetBackgroundColor(int viewID, CAL_scalar red, CAL_scalar green, CAL_scalar blue)
int CAL_SetObjectColor(int objID, CAL_scalar red, CAL_scalar green, CAL_scalar blue, CAL_scalar alpha=1, bool receiveShadows=true, int sID=0)
int CAL_SetGroupActiveMaterial(int groupID, bool subGroups, int sID)
int CAL_SetObjectActiveMaterial(int objID, int sID)
int CAL_CreateCylinderFromTo(int groupID, CAL_scalar *from, CAL_scalar *to, CAL_scalar radius, int *objID=CAL_NULL, char *name="")
int CAL_SetObjectTexture(int objID, int textureID, CAL_scalar xtile, CAL_scalar ytile, CAL_scalar alpha=1, bool receiveShadows=true, int sID=0)
int CAL_SetObjectSelectCallback(CAL_ObjectSelectCallback cb)
int CAL_SetGroupCollisionCheckCapability(int groupID, bool colCapable, bool subGroups=false)
int CAL_SetObjectOrientationMatrix(int objID, CAL_matrix3 mat, CAL_scalar time=-1)
int CAL_SetLabelCaption(int objID, char *caption)
int CAL_SetOverlayTextLine(int overlayID, int lineNr, char *text, float charHeight=10.f, float red=1.0f, float green=1.0f, float blue=1.0f, float alpha=1.0f)
int CAL_Initialisation(bool visualisation=true, char *logFile=CAL_NULL, char *visLogFile=CAL_NULL)
int CAL_ClearObjectOrientations(int objID)
int CAL_SaveGroupStatistics(int groupID, char *fileName)
int CAL_GetGroup(int groupID, void *CALGroup)
int CAL_SetGroupVisibility(int groupID, int viewID, bool visible, CAL_scalar time=-1)
int CAL_GetCameraRoll(int viewID, CAL_scalar *roll)
int CAL_SetTextureFromMem(int textureID, int width, int height, unsigned char *tex)
float CAL_scalar
Definition: callisto52Types.h:4
int CAL_DestroyObject(int objID)
int CAL_DestroyLabel(int objID)
int CAL_LoadScene(char *fileName, int parentID, bool eraseCurrent, char *&error)
int CAL_CheckPointCollision(int groupID, CAL_scalar x, CAL_scalar y, CAL_scalar z, bool multiple, int *nrCols)
int CAL_SetObjectVisibility(int objID, int viewID, bool visible, CAL_scalar time=-1)
int CAL_SetCameraOptions(int viewID, long options)
int CAL_CreateBox(int groupID, CAL_scalar xw, CAL_scalar yw, CAL_scalar zw, int *objID=CAL_NULL, char *name="")
int CAL_CreateTetrahedron(int groupID, CAL_scalar *p, int *objID=CAL_NULL, char *name="")
int CAL_SetGroupColor(int groupID, CAL_scalar red, CAL_scalar green, CAL_scalar blue, CAL_scalar alpha=1, bool receiveShadows=true, bool subGroups=false, int sID=0)
int CAL_GetResults(void *userResults)
int CAL_ResumeVisualisation()
int CAL_CreateElevationGrid(int groupID, int xDim, int zDim, CAL_scalar xStep, CAL_scalar zStep, CAL_scalar *heights, int *objID=CAL_NULL, char *name="")
int CAL_GetPenetrationDepths(int groupID0, int groupID1, int *nrPairs)
int CAL_CloneGroupRecursive(int *newgroupIDs, int groupID, int parentID, int nr, int *ids, char **names=CAL_NULL, bool cloneObjs=true, bool keepColCap=false)
int CAL_SetGroupScaling(int groupID, CAL_scalar xScale, CAL_scalar yScale, CAL_scalar zScale, CAL_scalar time=-1)
int CAL_SetObjectClearance(int objID, CAL_scalar clearance)
int CAL_SetCameraState(int viewID, CAL_scalar pos[3], CAL_scalar lookAt[3], CAL_scalar up[3], CAL_scalar time=-1)
int CAL_GatherStatistics(int enable)
int CAL_CreatePointCloud(int groupID, int nrPoints, CAL_scalar *points, CAL_scalar *colors=CAL_NULL, int *objID=CAL_NULL, char *name="")
int CAL_CheckGroupCollision(int group0, int group1, bool multiple, int *nrCols)
int CAL_SetGroupOrientationQuaternion(int groupID, CAL_scalar x, CAL_scalar y, CAL_scalar z, CAL_scalar w, CAL_scalar time=-1)
int CAL_CreateConeFromTo(int groupID, CAL_scalar *from, CAL_scalar *to, CAL_scalar radius, int *objID=CAL_NULL, char *name="")
int CAL_SaveScene(char *fileName, int groupID)
int CAL_ClearObjectScalings(int objID)
int CAL_CloneGroup(int *groupIDNew, int groupID, int parentID, bool colCheck, char *name="", bool cloneObjs=true)