WebMax2.0函数库.doc

1、简介52、API说明52.1三维API函数6AddFlashCtrl(flashName, FlashFile, alignMode, Left, Top, width, height, Loop)6DeleteFlashCtrl( flashName )6SetFlashRect (flashName, alignMode, left, top, width, height)7SetFlashCtrlVisibility(flashName, status)7SetFlashPlayStatus(flashName, status)8SetFlashCurrentFrame(flashName, frameIndex)82.11系统回调及相关函数9LoadN3DFile(strN3DFileName, N3DName)9EnableMouseDownCallback()9DisableMouseDownCallback()9EnableMouseUpCallback()9DisableMouseUpCallback()10EnableMouseDBClickCallback()10DisableMouseDBClickCallback()10EnableMouseMoveCallback()10DisableMouseMoveCallback()102.12场景函数12SetRenderStatus(status)12ShowDefaultLogo(status)12ResetScene()12SetAlphaTestLevel(level)12SetMouseMoveEventTimer(timeStep)122.13 控制相关函数13SetCollisionDistance(distance)13SetServer(strServer)13SetControlStatus(status)13SetEditCtrl_RosAxis(rosHint)13SetEditCtrl_DollySpeed(dollySpeed)14SetEditCtrl_DollyDistance(nearDis, farDis)14SetEditCtrl_AutoParam(PitchSpeedValue,RoundSpeedValue, RollSpeedValue)14SetEditCtrl_AutoPitchRoundRoll(status)14SetEditCtrl_ManualParam(PitchSpeed, RoundSpeed)15SetWalkCtrl_ManualParam(moveSpeed, moveAcc, rotateSpeed, rotateAcc, height)15SetFBL(fblValue)15SetAntiAliasLevel(level)15PlayKeyFrame()16PauseKeyFrame()16StopKeyFrame()16SetKeyFrameRepeatCount(repeatCnt)16GotoFrame(frame)16SetKeyFramePlaySpeed(fps)16PlayKeyFrame1（startFrame, endFrame）16SetDynamicTexPlaySpeed(TextuerName, Speed)16SetPlayerCanMove(status)17SetPlayerCanRos(status)17SetPlayerCanZoom(status)17SetPlayerCanLift(status)17PlayerGoForward()17PlayerGoBackward()17PlayerGoLeftward()17PlayerGoRightward()17PlayerStop()17PlayerTurnLeft()17PlayerTurnRight()17PlayerTurnUp()17PlayerTurnDown()17PlayerGoUp()17PlayerGoDown()18PlayerZoomIn()18PlayerZoomOut()182.14 相机相关函数19MoveCamera(cameraName, x, y, z, stepCnt, coordEnum)19MoveCurrentCamera(x, y, z, stepCnt, coordEnum)19SetCurrentCameraByName(camName)19SetCameraClip(cameraName, nearClip, farClip)19SetCurrentCameraClip(nearClip, farClip)20DollyCurrentCamera(value, stepCnt)20DollyCamera(cameraName, value, stepCnt)20MoveCurrentCameraTo(from_x, from_y, from_z, at_x, at_y, at_z, frameCnt, accType)20MoveCurrentCameraFromTo(x, y, z)20MoveCurrentCameraAtTo(x, y, z)21MoveCurrentCameraFrom(x, y, z)21MoveCurrentCameraAt(x, y, z)21RotateCurrentCamera(x, y, z, stepCnt, coordEnum)21RotateCamera(cameraName, x, y, z, stepCnt, coordEnum)22FocusCurrentCameraTo(model1Name, model2Name, x, y, z, distance, stepCnt)22SetPlayerZoomSpeed(speed)22SetCameraFrom(cameraName, x, y, z)22SetCameraAt(cameraName, x, y, z)23SetCameraFov(cameraName, fov)23SetCurrentCameraFov(fov)23CreateCamera(name, fromX, fromY, fromZ, atX, atY, atZ, fov, nearClip, farClip)23StopCameraKfr(camName)24PauseCameraKfr(camName)24ResumeCameraKfr(cameraName)24PlayCameraKfr(camName, repeatCnt)24SetCurrentCameraFrom(x, y, z)25CurCamGotoFrame(Frame)25SetCurrentCameraAt(x, y, z)252.15 模型相关函数26SetModelVisibility (modelName, visible)26SetDynamicUV(modelName, u, v, speed)26SetModelClickable(modelName, clickable)26SetModelOpacity(modelName, opacity)26HideAllModels()26ShowAllModels()26MoveModel(modelName, x, y, z, coordEnum)27MoveModelTo(modelName, x, y, z, frameCnt, accType)27DeleteModel(modelName)27SetModelEventOnMouseMove(status)27SetModelMouseHint(modelName, bFlag)28SetModelMouseColor(modelName, mouseOver_Red,mouseOver_Green,mouseOver_Blue, mouseOver_Alpha,mouseClick_Red,mouseClick_Green, mouseClick_Blue,mouseClick_Alpha)28SetModelMouseHintType(modelName, type)28SetModelPosition(modelName, x, y, z)29SetModelPositionByPivot(modelName, x, y, z)29SetModelRotation(modelName, x, y, z)29SetModelKfrPlayStatus(modelName, bKfrPlay)30SetAllModelKfrPlayStatus(bKfrPlay)30SetModelKfrRepeatCnt(modelName, kfrRepeatCnt)30SetAllModelKfrRepeatCnt(kfrRepeatCnt)30PlayModelKfr(modelName, startFrame, endFrame, repeatCnt)302.16灯光相关函数32SetLightColor(lightName, red, green, blue)32SetLightPower(lightName, power)32SetLightAmbient(lightName, red, green, blue)32SetLightPosition(lightName, x, y, z)32SetLightRange(lightName, range)33SetLightAttenuation(lightName, attenuation0, attenuation1, attenuation2)33SetLightStatus(lightName, status)33SetLightKfrPlayStatus(lightName, bFlag)33SetAllLightKfrPlayStatus(bFlag)34SetLightKfrRepeatCnt(lightName, repeatCnt)34SetAllLightKfrRepeatCnt(repeatCnt)342.17三维特效函数35DeleteAudioByName(BSTR name)35DeleteAudioByIndex(INT index)35DeleteAllAudio()35SetAudioFile(BSTR audioName, BSTR audioFile)35SetAudioRepeatCount(BSTR audioName, INT repeatCnt)35PlayAudio(BSTR audioName)36PauseAudio(BSTR audioName)36StopAudio(BSTR audioName)36RewindAudio(BSTR audioName)362.2界面API函数372.21 Overlay(前景图)相关函数37SetOverlayOpacity(overlayName, opacity)37SetOverlayWidth(overlayName, width)37SetOverlayHeight(overlayName, height)37SetOverlayAlignMode(overlayName, alignMode)37SetOverlayRect(overlayName, left, top, width, height)38MoveOverlay(overlayName, x, y)38SetOverlayVisibility(overlayName, visible)38SetOverlayFullScreen(overlayName, xFull, yFull)39PushOverlayFront(overlayName)39PushOverlayBack(overlayName)392.22背景图相关函数40SetBackgroundColor(red, green, blue)402.23 按钮相关函数41SetButtonVisibility(btnName, visible)41SetButtonActive(name, bActive)41VGS II ActiveX插件JavaScript编程接口说明1、 简介本文档面向使用VGS II ActiveX插件制作动态三维虚拟网页的程序开发者，简要介绍了VGS II ActiveX插件的JavaScript编程接口。2、 API说明* 所有在3DSMax中制作的模型名称、材质名称、贴图名、相机名称、灯光名称等，在Javascript中必须全部用大写字母。2.1三维API函数AddFlashCtrl(flashName, FlashFile, alignMode, Left, Top, width, height, Loop)加载Flash控件，显示Flash文件，但并不播放。参数： flashNameFlash文件的别名，用于索引该Flash文件。 sFlashFileFlash文件路径与文件名称。 alignMode Flash显示矩形区域的对齐方式基准位置。 0绝对坐标 1左对齐 2右对齐 3底部对齐 4顶部对齐 5对齐至左上角 6顶部居中对齐 7对齐至右上角 8对齐至左下角 9底部居中对齐 10对齐至右下角 11居中对齐 LeftFlash显示矩形区域左边的坐标值。 Top Flash显示矩形区域顶边的坐标值。 widthFlash显示矩形区域右边的坐标值。 height Flash显示矩形区域底部的坐标值。 LoopFlash文件是否循环播放例：/ 加载自定义的Flash文件作为logoVGS2.AddFlashCtrl(”LOGO”, ”load.swf”, 11, 0, 0, 400, 400, 1);DeleteFlashCtrl( flashName )删除场景中的Flash控件。参数： flashNameFlash文件的别名，用于索引该Flash文件。例： /删除自定义的Flash文件 VGS2.DeleteFlashCtrl(LOGO);SetFlashRect (flashName, alignMode, left, top, width, height)设置Flash的Rect。参数： flashNameFlash文件的别名，用于索引该Flash文件。 alignMode Flash显示矩形区域的对齐方式基准位置。 0绝对坐标 1左对齐 2右对齐 3底部对齐 4顶部对齐 5对齐至左上角 6顶部居中对齐 7对齐至右上角 8对齐至左下角 9底部居中对齐 10对齐至右下角 11居中对齐 LeftFlash显示矩形区域左边的坐标值。 Top Flash显示矩形区域顶边的坐标值。 widthFlash显示矩形区域右边的坐标值。 height Flash显示矩形区域底部的坐标值。例：/设置Flash的窗体VGS2.SetFlashRect(”LOGO”, 11, 0, 0, 400, 400);SetFlashCtrlVisibility(flashName, status)设置Flash是否可见。参数： flashNameFlash文件的别名，用于索引该Flash文件。 status 是否可见。true为可见，false位隐藏。例： /设置Flash可见。 VGAS2.SetFlashCtrlVisibility(LOGO, true);SetFlashPlayStatus(flashName, status)设置Flash播放状态。参数： flashNameFlash文件的别名，用于索引该Flash文件。 status 播放状态。 0暂停播放 1从暂停点开始播放 2停止并跳转到第一帧例： /设置Flash暂停播放 VGS2.SetFlashPlayStatus(LOGO, 0);SetFlashCurrentFrame(flashName, frameIndex)跳转Flash到指定的帧。参数： flashNameFlash对象名称。 frameIndex 帧编号。例：VGS2.SetFlashCurrentFrame(”FLASH01”, 10); 2.11系统回调及相关函数LoadN3DFile(strN3DFileName, N3DName)LoadN3D文件到场景。参数： strN3DFileName网络上的N3D文件名称。 N3DName N3D文件的代名词。例：/加载N3D文件VGS2.LoadN3DFile(XIZUN.N3D, XIZUN);EnableMouseDownCallback()启用鼠标左键按下事件回调函数。默认为禁用。对应的回调函数签名为：function VGSMouseDown(LocH, LocV, type, modelUnderLoc);例：VGS2.EnableMouseDownCallback();DisableMouseDownCallback()禁用鼠标左键按下事件回调函数。默认为禁用。对应的回调函数签名为：function VGSMouseDown(LocH, LocV, type, modelUnderLoc);例：VGS2.DisableMouseDownCallback();EnableMouseUpCallback()启用鼠标左键抬起事件回调函数。默认为禁用。对应的回调函数签名为：function VGSMouseUp(LocH, LocV, type, modelUnderLoc);例：VGS2.EnableMouseUpCallback();DisableMouseUpCallback()禁用鼠标左键抬起事件回调函数。默认为禁用。对应的回调函数签名为：function VGSMouseUp(LocH, LocV, type, modelUnderLoc);例：VGS2.DisableMouseUpCallback();EnableMouseDBClickCallback()启用鼠标双击事件回调函数。默认为禁用。对应的回调函数签名为：function VGSMouseDBClick(LocH, LocV, type, modelUnderLoc);例：VGS2.EnableMouseDBClickCallback();DisableMouseDBClickCallback()禁用鼠标双击事件回调函数。默认为禁用。对应的回调函数签名为：function VGSMouseDBClick(LocH, LocV, type, modelUnderLoc);例：VGS2.DisableMouseDBClickCallback();EnableMouseMoveCallback()启用鼠标移动事件回调函数。默认为禁用。对应的回调函数签名为：function VGSMouseMove(LocH, LocV, type, modelUnderLoc);例：VGS2.EnableMouseMoveCallback();DisableMouseMoveCallback()禁用鼠标移动事件回调函数。默认为禁用。对应的回调函数签名为：function VGSMouseMove(LocH, LocV, type, modelUnderLoc);例：VGS2.DisableMouseMoveCallback();2.12场景函数SetRenderStatus(status)设置场景是否渲染。参数： status 场景的渲染状态。True为渲染，false为不渲染。例： /设置场景渲染 VGS2.SetRenderStatus(true);ShowDefaultLogo(status)是否显示默认的Logo。参数： status 是否显示。true 为显示，false为隐藏。例： /显示默认的Logo VGS2.ShowDefaultLogo(true);ResetScene()释放场景。例：VGS2. ResetScene ();SetAlphaTestLevel(level)设置alpha测试参数： level 0255之间的值。SetMouseMoveEventTimer(timeStep)设置鼠标移动响应时间间隔。参数： timeStep 毫秒间隔。例：VGS2.SetMouseMoveEventTimer(300);2.13 控制相关函数SetCollisionDistance(distance)设置碰撞发生的距离。参数： distance 有效距离。例：/设置碰撞的有效距离VGS2. SetCollisionDistance (600);SetServer(strServer)设置服务器路径。插件将该路径设置为根路径。参数： sWebServer 服务器路径。例： /设置当前页面路径为服务器路径 VGS2.SetServer(location.href);SetControlStatus(status)设置控制状态。参数： status 控制状态。 0Walk模式 1Eidt模式 2Fly模式 3 None模式例：/设置为编辑模式VGS2.SetControlStatus(1);SetEditCtrl_RosAxis(rosHint)设置旋转轴，EDIT模式有效，设置鼠标拖拽时的旋转轴。参数： rosHint 旋转中心轴标示。 0 即可绕x轴又能绕y轴旋转 1 只可绕x轴旋转 2 只可绕y轴旋转例：/设置旋转轴VGS2.SetEditCtrl_RosAxis(0);SetEditCtrl_DollySpeed(dollySpeed)推进拉远相机的速度，EDIT模式有效。参数： dollySpeed 推拉的速度。例： /设置最远和最近鼠标滚轮Dolly距离VGS2.SetEditCtrl_DollySpeed(5);SetEditCtrl_DollyDistance(nearDis, farDis)设置鼠标滚轮推拉镜头的最近和最远距离，EDIT模式下有效。参数： nearDis 最近距离。 farDis 最远距离。例：/设置最远最近鼠标滚轮Dolly距离VGS2.SetEditCtrl_DollyDistance(20, 1000);SetEditCtrl_AutoParam(PitchSpeedValue,RoundSpeedValue, RollSpeedValue)设置当前相机自动Round速度。参数： PitchSpeedValue 相机绕x轴旋转速度。 RoundSpeedValue 相机绕y轴旋转速度。 RollSpeedValue 相机绕z轴旋转速度。例：/设置港开始相机自动Round速度VGS2.SetEditCtrl_AutoParam(0, 0.01, 0);SetEditCtrl_AutoPitchRoundRoll(status)设置镜头是否自动旋转和翻滚，EDIT模式下有效。参数： status 1为自动旋转翻滚，0为静止。例：/设置相机自动旋转VGS2.SetEditCtrl_AutoPitchRoundRoll(1);SetEditCtrl_ManualParam(PitchSpeed, RoundSpeed)设置镜头手动旋转翻滚的速度，EDIT模式有效。参数： PitchSpeed 相机绕x轴旋转速度。 RoundSpeed 相机绕y轴旋转速度。例：/设置为手动模式VGS2.SetEditCtrl_ManualParam(0.02, 0.02);SetWalkCtrl_ManualParam(moveSpeed, moveAcc, rotateSpeed, rotateAcc, height)设置在行走模式中的运动参数。参数： moveSpeed 移动速度。 moveAcc 移动加速度。0到1之间的浮点数。 rotateSpeed 转动速度。 rotateAcc 转动加速度。0到1之间的浮点数。 height 行走高度。例：/设置手动相机的行走参数VGS2.SetWalkCtrl_ManualParam(10.0, 0.5, 0.03, 0.05, 180);SetFBL(fblValue)设置FBL数值，FBL是指当模型的包围球半径除以模型中心到相机的位置得到的参考数值如果模型的FBL小于预设的FBL，则不渲染该模型，这有利于优化场景，不渲染远处的小体量模型。参数： fblValue fbl数值。例：/设置FBLVGS2.SetFBL(0.05);SetAntiAliasLevel(level)设置系统的抗拒齿级别。参数： level 级别。 PlayKeyFrame()播放关键帧。PauseKeyFrame()暂停关键帧。StopKeyFrame()停止播放关键帧。SetKeyFrameRepeatCount(repeatCnt)设置关键帧的重复次数。参数： repeatCnt 循环次数。-1为一直循环播放，1为循环一次。例：VGS2. SetKeyFrameRepeatCount(1);GotoFrame(frame)跳到关键帧的某一帧。参数： frame 帧数。例：VGS2.GotoFrame(200);SetKeyFramePlaySpeed(fps)设置关键帧的播放速度 fps为每秒播放的帧率。参数： fps 帧率。PlayKeyFrame1（startFrame, endFrame）播放区间关键帧动画参数： startFrame 起始帧。 endFrame 结束帧。例：/播放1到160帧的区间关键帧动画VGS2.PlayKeyFrame1(0, 160);SetDynamicTexPlaySpeed(TextuerName, Speed) 序列帧的播放速度参数： startFrame 起始帧。 endFrame 结束帧。例：/控制序列帧的速度VGS2.SetDynamicTexPlaySpeed(DynamicTexture_1, 5);SetPlayerCanMove(status)设置当前Player是否可以控制移动。参数： status 是否可控制移动。1为启用，0为禁用。SetPlayerCanRos(status)设置当前Player是否可以控制旋转。参数： status 是否可控制旋转。1为启用，0为禁用。SetPlayerCanZoom(status)设置当前Player是否可以控制推拉镜头。参数： status 是否可控制推拉镜头。1为启用，0为禁用。SetPlayerCanLift(status)设置当前Player是否可以控制镜头升降。参数： status 是否可控制升降。1为启用，0为禁用。PlayerGoForward()向前走。PlayerGoBackward()向后退PlayerGoLeftward()向左走。PlayerGoRightward()向右走。PlayerStop()停止。PlayerTurnLeft()左旋转。PlayerTurnRight()右旋转。PlayerTurnUp()上旋转。PlayerTurnDown()下旋转。PlayerGoUp()上移动。PlayerGoDown()下移动。PlayerZoomIn()镜头推进。PlayerZoomOut()镜头拉远。2.14 相机相关函数MoveCamera(cameraName, x, y, z, stepCnt, coordEnum)移动指定摄像机。参数： cameraName 摄像机名称。 x, y, z 移动的距离。 stepcnt 移动的步数。 coordEnum 参考坐标系（from和at一起移动）。 0 世界坐标系 1 自身坐标系例： /移动相机camera01 VGS2.MoveCamera（CAMERA01, 1.0, 1.0, 1.0, 0, 1）;MoveCurrentCamera(x, y, z, stepCnt, coordEnum)移动当前摄像机（from和at一起移动）。参数： x, y, z 移动的距离。 stepcnt 移动的步数。 coordEnum 参考坐标系。 0世界坐标系 1自身坐标系 例： /移动当前相机VGS2.MoveCurrentCamera(1.0, 1.0, 1.0, 0, 1);SetCurrentCameraByName(camName)设置场景中的当前相机。参数： camName 3DSMax中指定的相机名称。例： /设置场景中的当前相机位camera01 VGS2.SetCurrentCameraByName(CAMERA01);SetCameraClip(cameraName, nearClip, farClip)设置相机的远裁减面与近裁减面。远于远裁减面或近于近裁减面的模型将不被显示。远裁减面与近裁减面的比值不应大于10000。参数： cameraName 相机名称。 nearClip 近裁减面值。 farClip 远裁减面值。例： /设置相机camera01的剪切面 VGS2.SetCameraClip(CAMERA01, 500, 10000);SetCurrentCameraClip(nearClip, farClip)设置当前的相机的远裁减面与近裁减面。远于远裁减面或近于近裁减面的模型将不被显示。远裁减面与近裁减面的比值不应大于10000。参数： nearClip 近裁减面值。 farClip 远裁减面值。例： /设置当前相机的剪切面 VGS2.SetCurrentCameraClip(1000, 50000);DollyCurrentCamera(value, stepCnt)推拉当前相机的镜头。参数： value 当前相机推拉的距离。 stepCnt 当前相机推拉的步数。DollyCamera(cameraName, value, stepCnt)推拉指定相机的镜头。参数： cameraName 相机的名称。 value 推拉的距离。 stepCnt 推拉的步数。MoveCurrentCameraTo(from_x, from_y, from_z, at_x, at_y, at_z, frameCnt, accType)移动当前摄像机。参数： from_x, from_y, from_z 移动的坐标。 at_x, at_y, at_z 世界坐标。 frameCnt 帧数。 accType 加速模式。 0 匀速运动。 1 匀加速。 2 匀减速。 例：/移动当前摄像机VGS2.MoveCurrentCameraTo(50.0, 100.0, 284.0, 0, 0, 0, 142, 0);MoveCurrentCameraFromTo(x, y, z)移动相机的From到D3DXVECTOR(x, y, z)。参数： x, y, z 位置坐标。例：/移动相机fromVGS2. MoveCurrentCameraFromTo(100.0, 120.0, 300.0);MoveCurrentCameraAtTo(x, y, z)移动相机的At到D3DXVECTOR(x, y, z)。参数： x, y, z 位置坐标。例：/移动相机的AtVGS2. MoveCurrentCameraAtTo(1000.0, 1200.0, 3000.0);MoveCurrentCameraFrom(x, y, z)移动相机的From +=D3DXVECTOR(x, y, z)。参数： x, y, z 位置坐标。例：/移动相机FromVGS2. MoveCurrentCameraFrom (100.0, 120.0, 300.0);MoveCurrentCameraAt(x, y, z)移动相机的At += D3DXVECTOR(x, y, z)。参数： x, y, z 位置坐标。例：/移动相机FromVGS2. MoveCurrentCameraAt (100.0, 120.0, 300.0);RotateCurrentCamera(x, y, z, stepCnt, coordEnum)旋转当前相机参数： x 沿X轴旋转的偏移量（弧度）。 y 沿Y轴旋转的偏移量（弧度）。 z 沿Z轴旋转的偏移量（弧度）。 stepCnt 平滑旋转相机的步进数，以帧为单位。 coordEnum 坐标系枚举值。 0 世界坐标系 1 自身坐标系 2 行走坐标系例：VGS2.RotateCurrentCamera(0.3, 0.3, 0.3, 30, 1);RotateCamera(cameraName, x, y, z, stepCnt, coordEnum)旋转特定相机。参数： cameraName 相机名称。 x 沿X轴旋转的偏移量（弧度）。 y 沿Y轴旋转的偏移量（弧度）。 z 沿Z轴旋转的偏移量（弧度）。 stepCnt 平滑旋转相机的步进数，以帧为单位。 coordEnum 坐标系枚举值。 0 世界坐标系 1 自身坐标系 2 行走坐标系例：VGS2.RotateCamera(CAMERA01, 0.3, 0.3, 0.3, 30, 1);FocusCurrentCameraTo(model1Name, model2Name, x, y, z, distance, stepCnt)对正相机，显示包括起始与结束两个模型及二者之间的模型。参数： model1Name 起始模型的名称 model2Name 结束模型的名称。 x 相机方向的X轴分量。 y 相机方向的Y轴分量。 z 相机方向的Z轴分量。 distance 相机目标点到起始点的距离。 stepCnt 平滑运动相机的步进数，以帧为单位。例：/ 将相机对正显示模型DUN1至DUN30之间的模型，步进数为30VGS2.FocusCurrentCameraTo(”DUN1”, ”DUN30”, 0, 1, 0, 50, 30);SetPlayerZoomSpeed(speed)设置相机推拉速度。参数： speed 推拉的速度。例：VGS2.SetPlayZoomSpeed(20.0);SetCameraFrom(cameraNa