CommonConstant - Documentation

ApplicationControl

应用相关的控制参数

CameraControl

相机相关的控制参数

ControlSchemeType

默认值:

{
  "LockedMouse": 0,
  "HoveringMouse": 1
}

属性:

Name	Type	Description
`LockedMouse`	number	A mouse can lock inside the WebRTC player so the user can simply move the mouse to control the orientation of the camera. The user presses the Escape key to unlock the mouse.
`HoveringMouse`	number	A mouse can hover over the WebRTC player so the user needs to click and drag to control the orientation of the camera.

DrawAndMeasureControl

绘制量测相关的几何体与云端交互时的名称

默认值:

{
  "ENABLE_DRAW": "Gis_enableDraw",
  "CLOSE_DRAW": "Gis_closeDraw",
  "ENABLE_MEASURE": "Gis_enableMeasure",
  "CLOSE_MEASURE": "Gis_closeMeasure",
  "DESTORY_DRAW": "Gis_clearDraw",
  "DESTORY_MEASURE": "Gis_clearMeasure"
}

属性:

Name	Type	Description
`ENABLE_DRAW`	String	开启绘制
`CLOSE_DRAW`	String	关闭绘制
`ENABLE_MEASURE`	String	开启量测
`CLOSE_MEASURE`	String	关闭量测
`DESTORY_DRAW`	String	销毁所有绘制的几何
`DESTORY_MEASURE`	String	销毁所有量测的几何

GisControl

位置相关的几何体与云端交互时的名称

默认值:

{
  "ADD": "Gis_AddCommonGISLayer",
  "REMOVE": "Gis_RemoveCommonGISLayer",
  "DESTORY": "Gis_DestoryCommonGISLayer",
  "DESTORY_ALL": "Gis_DestoryAllGenerationLayer",
  "UPDATE": "Gis_UpdateCommonGISLayer",
  "VISIBLE": "Gis_VisibleCommonGISLayer"
}

属性:

Name	Type	Description
`ADD`	String	添加
`REMOVE`	String	移除
`DESTORY`	String	销毁
`DESTORY_ALL`	String	销毁所有已添加物体
`UPDATE`	String	更新
`VISIBLE`	String	显隐

InteractMOD

鼠标键盘交互

默认值:

{
  "SET_MOUSE_CURSOR_SHOW": "setMouseCursorShow",
  "SET_CLICK_EVENT": "setClickEvent",
  "SET_EDIT_STATUS": "setEditStatus",
  "SWITCH_EDIT_MODE": "switchEditMode",
  "SAVE_EDIT_RESULT": "saveEditResult",
  "ZOOM_IN": "zoomIn",
  "ZOOM_OUT": "zoomOut",
  "EXIT": "exitClient",
  "ENABLE_TERRAIN": "enableTerrain",
  "ENABLE_POI": "enablePOIByTag",
  "PRELOAD_LOCATION": "preLoadLocation",
  "FOCUS_ACTOR_BY_ID": "focusActorByID",
  "ENABLE_DATALAYER": "Scene_enableDataLayerByName",
  "ENABLE_FPS": "Scene_setFPS",
  "OBJECT_BOUNDINGBOX": "Interact_objectBoundingBox",
  "ASSET_MODEL": "Gis_generateAssetModel",
  "BUILD_GROWTHANIMATE": "Interact_buildGrowth"
}

属性:

Name	Type	Description
`SET_MOUSE_CURSOR_SHOW`	String	设置场景鼠标显隐
`SET_CLICK_EVENT`	String	设置点击事件开关
`SET_EDIT_STATUS`	String	设置编辑状态开关
`SWITCH_EDIT_MODE`	String	切换编辑模式
`SAVE_EDIT_RESULT`	String	保存编辑结果
`ZOOM_IN`	String	缩放
`ZOOM_OUT`	String	缩放
`EXIT`	String	退出游戏
`ENABLE_TERRAIN`	String	开关地形
`ENABLE_POI`	String	根据Tag开关指定POI
`PRELOAD_LOCATION`	String	预加载指定位置
`FOCUS_ACTOR_BY_ID`	String	聚焦到指定id的actor
`ENABLE_DATALAYER`	String	根据名字启用图层
`ENABLE_FPS`	String	fps统计值
`OBJECT_BOUNDINGBOX`	String	物体包围盒
`ASSET_MODEL`	String	资产管理平台的模型
`BUILD_GROWTHANIMATE`	String	建筑生长动画控制

LineDirectionOptions

线的拓宽方向

属性:

Name	Type	Description
`CENTER`		默认
`STAND`		站立
`SIDE`		边缘偏移
`SIDE`		圆柱

LineSplineTypeOptions

线的样条点类型

属性:

Name	Type	Description
`LINEAR`		线性
`CURVE`		曲线
`CONSTANT`		常量

LineTypeOptions

线型

属性:

Name	Type	Description
`SOLID`		实线
`DASHED`		虚线
`ARROW`		箭头
`GRADIENT`		透明渐变

MessageType

MessageType - Must be kept in sync with PixelStreamingProtocol::EToUE4Msg C++ enum.

默认值:

{
  "IFrameRequest": 0,
  "RequestQualityControl": 1,
  "FpsRequest": 2,
  "AverageBitrateRequest": 3,
  "StartStreaming": 4,
  "StopStreaming": 5,
  "LatencyTest": 6,
  "RequestInitialSettings": 7,
  "UIInteraction": 50,
  "Command": 51,
  "KeyDown": 60,
  "KeyUp": 61,
  "KeyPress": 62,
  "MouseEnter": 70,
  "MouseLeave": 71,
  "MouseDown": 72,
  "MouseUp": 73,
  "MouseMove": 74,
  "MouseWheel": 75,
  "TouchStart": 80,
  "TouchEnd": 81,
  "TouchMove": 82,
  "GamepadButtonPressed": 90,
  "GamepadButtonReleased": 91,
  "GamepadAnalog": 92
}

属性:

Name	Type	Description
`IFrameRequest`	number
`RequestQualityControl`	number
`FpsRequest`	number
`AverageBitrateRequest`	number
`StartStreaming`	number
`StopStreaming`	number
`LatencyTest`	number
`RequestInitialSettings`	number
`UIInteraction`	number
`Command`	number
`KeyDown`	number
`KeyUp`	number
`KeyPress`	number
`MouseEnter`	number
`MouseLeave`	number
`MouseDown`	number
`MouseUp`	number
`MouseMove`	number
`MouseWheel`	number
`TouchStart`	number
`TouchEnd`	number
`TouchMove`	number
`GamepadButtonPressed`	number
`GamepadButtonReleased`	number
`GamepadAnalog`	number

MouseButton

鼠标按钮 - https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button

默认值:

{
  "MainButton": 0,
  "AuxiliaryButton": 1,
  "SecondaryButton": 2,
  "FourthButton": 3,
  "FifthButton": 4
}

属性:

Name	Type	Description
`MainButton`	number	Left button.
`AuxiliaryButton`	number	Wheel button.
`SecondaryButton`	number	Right button.
`FourthButton`	number	Browser Back button.
`FifthButton`	number	Browser Forward button.

MouseButtonsMask

MouseButtonsMask - https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons

默认值:

{
  "PrimaryButton": 1,
  "SecondaryButton": 2,
  "AuxiliaryButton": 4,
  "FourthButton": 8,
  "FifthButton": 16
}

属性:

Name	Type	Description
`PrimaryButton`	number	Left button.
`SecondaryButton`	number	Right button.
`AuxiliaryButton`	number	Wheel button.
`FourthButton`	number	Browser Back button.
`FifthButton`	number	Browser Forward button.

ParticleKind

粒子效果

属性:

Name	Type	Description
`FIRE_BIG`	string	大火
`FIRE_SMALL`	string	小火
`FIRE_FLAMETHROWER`	string	喷火
`SMOKE_SMALL_BLACK`	string	小型烟雾
`SMOKE_BIG_BLACK`	string	大型烟雾
`SMOKE_SMALL_YELLOW`	string	地面烟雾
`SMOKE_BIG_YELLOW`	string	大型地面烟雾
`SPARK_A`	string	烟花
`FOG_MASS`	string	团雾
`NS_Spark`	string	上升线条
`NS_Firefly`	string	萤火虫粒子

SkyColorMode

天气模式

SkyMode

天气模式

SpecialKeyCodes

SpecialKeyCodes
Must be kept in sync with JavaScriptKeyCodeToFKey C++ array. The index of the
entry in the array is the special key code given below.

默认值:

{
  "BackSpace": 8,
  "Shift": 16,
  "Control": 17,
  "Alt": 18,
  "RightShift": 253,
  "RightControl": 254,
  "RightAlt": 255
}

属性:

Name	Type	Description
`BackSpace`	number
`Shift`	number
`Control`	number
`Alt`	number
`RightShift`	number
`RightControl`	number
`RightAlt`	number

ToClientMessageType

ClientMessageType

默认值:

{
  "QualityControlOwnership": 0,
  "Response": 1,
  "Command": 2,
  "FreezeFrame": 3,
  "UnfreezeFrame": 4,
  "VideoEncoderAvgQP": 5,
  "LatencyTest": 6,
  "InitialSettings": 7,
  "FileExtension": 8,
  "FileMimeType": 9,
  "FileContents": 10,
  "Mouse": 21,
  "Keyboard": 22,
  "InputControlOwnership": 12,
  "Protocol": 255
}

属性:

Name	Type	Description
`QualityControlOwnership`	number
`Response`	number
`Command`	number
`FreezeFrame`	number
`UnfreezeFrame`	number
`VideoEncoderAvgQP`	number
`LatencyTest`	number
`InitialSettings`	number
`FileExtension`	number
`FileMimeType`	number
`FileContents`	number
`Mouse`	number
`Keyboard`	number
`InputControlOwnership`	number
`Protocol`	number

UDS

天气相关

默认值:

{
  "CLEAR_SKIES": "clearSkies",
  "PARTLY_CLOUDY": "partlyCloudy",
  "CLOUDY": "cloudy",
  "FOGGY": "foggy",
  "OVERCAST": "overcast",
  "RAIN": "rain",
  "LIGHT_RAIN": "lightRain",
  "THUNDER_STORM": "thunderstorm",
  "SNOW": "snow",
  "LIGHT_SNOW": "lightSnow",
  "BLIZZARD": "blizzard",
  "SAND_DUST_CALM": "sandDustCalm",
  "SAND_DUST_STORM": "sandDustStorm"
}

属性:

Name	Type	Description
`CLEAR_SKIES`	String	净空
`PARTLY_CLOUDY`	String	少云
`CLOUDY`	String	多云
`FOGGY`	String	雾
`OVERCAST`	String	阴天
`RAIN`	String	中大雨
`LIGHT_RAIN`	String	小雨
`THUNDER_STORM`	String	风暴
`SNOW`	String	中大雪
`LIGHT_SNOW`	String	小雪
`BLIZZARD`	String	暴风雪
`SAND_DUST_CALM`	String	扬沙
`SAND_DUST_STORM`	String	沙尘暴

WS_OPEN_STATE

websocket的开启状态

默认值:

inputOptions

默认值:

{
  "controlScheme": "",
  "suppressBrowserKeys": false,
  "fakeMouseWithTouches": false
}

属性:

Name	Type	Description
`controlScheme`	Boolean	The control scheme controls the behaviour of the mouse when it interacts with the WebRTC player.
`suppressBrowserKeys`	Boolean	Browser keys are those which are typically used by the browser UI. We usually want to suppress these to allow, for example, UE4 to show shader complexity with the F5 key without the web page refreshing.
`fakeMouseWithTouches`	Boolean	UE4 has a faketouches option which fakes a single finger touch when the user drags with their mouse. We may perform the reverse; a single finger touch may be converted into a mouse drag UE4 side. This allows a non-touch application to be controlled partially via a touch device.

module: CommonConstant