From ebf16eeb1aaff0381cf8968d1c92facc6c7ebc4b Mon Sep 17 00:00:00 2001 From: Jeremy Hu Date: Sat, 23 Mar 2019 07:44:02 +0930 Subject: [PATCH] Update Remote IO document --- docs/remote_io_protocol.rst | 329 ++++++++++++++++++------------------ 1 file changed, 166 insertions(+), 163 deletions(-) diff --git a/docs/remote_io_protocol.rst b/docs/remote_io_protocol.rst index 9174ebb0..c3fa35f6 100644 --- a/docs/remote_io_protocol.rst +++ b/docs/remote_io_protocol.rst @@ -10,6 +10,9 @@ Protocol | Other software connect to tcp host 127.0.0.1:53309, send command, get reply and receive event from Dust3D. One command, or one response, consists of one packet, each packet encoded as hex string, and choose '\\0' as packet splitter. | | Each response start with a '+' or '-' when there is an error, the error message comes after the minus sign. +| +| Event start with a '#'. +| Python Example ================= @@ -52,167 +55,167 @@ Python Example Commands ================== -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| Command | Examples | -+==============================================================+============================================================================================================================+ -| listWindow | | send> listwindow | -| | | +OK | -| | | {658cac48-4cc4-42bf-a561-dbd28330777e} Dust3D%201.0.0-beta.17%20* | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| selectWindow | | send> selectwindow {658cac48-4cc4-42bf-a561-dbd28330777e} | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| undo | | send> undo | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| redo | | send> redo | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| paste | | send> paste | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| removeNode | | send> removeNode {3dc475f6-dcda-45b8-bb76-59948db39968} | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| removeEdge | | send> removeEdge {a75f39ac-3c78-4754-b34a-dce70779832b} | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| removePart | | send> removePart {79a15562-908c-4b74-a489-af604796b1a0} | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| addNode | | send> addNode 0.51 0.51 1.01 0.08 | -| | | +OK | -| | | | -| | | send> addNode 0.51 0.51 1.01 0.08 {3dc475f6-dcda-45b8-bb76-59948db39968} | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| addNodeWithId | | send> addNodeWithId {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.51 0.51 1.01 0.08 | -| | | +OK | -| | | | -| | | send> addNodeWithId {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.51 0.51 1.01 0.08 {3dc475f6-dcda-45b8-bb76-59948db39968} | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| scaleNodeByAddRadius | | send> scaleNodeByAddRadius {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.05 | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| moveNodeBy | | send> moveNodeBy {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.05 0.05 0.05 | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| setNodeOrigin | | send> setNodeOrigin {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.51 0.51 1.01 | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| setNodeRadius | | send> setNodeRadius {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.08 | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| setNodeBoneMark | | Available bone marks: Neck/Limb/Tail/Joint/None | -| | | | -| | | send> setNodeBoneMark {8d443cbf-fc73-4281-b3a1-268dd38b1c73} Neck | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| switchNodeXZ | | send> switchNodeXZ {8d443cbf-fc73-4281-b3a1-268dd38b1c73} | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| moveOriginBy | | send> moveOriginBy 0.01, 0.02, 0.013 | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| addEdge | | send> addEdge {a75f39ac-3c78-4754-b34a-dce70779832b} {507328fd-9baf-41d1-9e05-850fb41fcbfa} | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| setPartLockState | | send> setPartLockState {79a15562-908c-4b74-a489-af604796b1a0} locked | -| | | +OK | -| | | | -| | | send> setPartLockState {79a15562-908c-4b74-a489-af604796b1a0} unlocked | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| setPartVisibleState | | send> setPartVisibleState {79a15562-908c-4b74-a489-af604796b1a0} visible | -| | | +OK | -| | | | -| | | send> setPartVisibleState {79a15562-908c-4b74-a489-af604796b1a0} invisible | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| setPartSubdivState | | send> setPartSubdivState {79a15562-908c-4b74-a489-af604796b1a0} subdived | -| | | +OK | -| | | | -| | | send> setPartSubdivState {79a15562-908c-4b74-a489-af604796b1a0} unsubdived | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| setPartChamferState | | send> setPartChamferState {79a15562-908c-4b74-a489-af604796b1a0} chamfered | -| | | +OK | -| | | | -| | | send> setPartChamferState {79a15562-908c-4b74-a489-af604796b1a0} unchamfered | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| setPartRoundState | | send> setPartRoundState {79a15562-908c-4b74-a489-af604796b1a0} rounded | -| | | +OK | -| | | | -| | | send> setPartRoundState {79a15562-908c-4b74-a489-af604796b1a0} unrounded | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| setPartDisableState | | send> setPartDisableState {79a15562-908c-4b74-a489-af604796b1a0} disabled | -| | | +OK | -| | | | -| | | send> setPartDisableState {79a15562-908c-4b74-a489-af604796b1a0} undisabled | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| setPartXmirrorState | | send> setPartXmirrorState {79a15562-908c-4b74-a489-af604796b1a0} mirrored | -| | | +OK | -| | | | -| | | send> setPartXmirrorState {79a15562-908c-4b74-a489-af604796b1a0} unmirrored | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| setPartColor | | send> setPartColor {79a15562-908c-4b74-a489-af604796b1a0} red | -| | | +OK | -| | | | -| | | send> setPartColor {79a15562-908c-4b74-a489-af604796b1a0} | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| getNodePartId | | send> getNodePartId {3dc475f6-dcda-45b8-bb76-59948db39968} | -| | | +OK | -| | | {b8f9ae53-999c-4851-9c2b-69a427fca10c} | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| saveSnapshot | | send> saveSnapshot | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| getSnapshot | | send> getSnapshot | -| | | +OK -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| exportAsObj | | send> exportAsObj | -| | | +OK -| | | # DUST3D -| | | v -0.08 0.08 0.08 -| | | v -0.08 -0.08 0.08 -| | | v 0.08 -0.08 0.08 -| | | v 0.08 -0.08 -0.08 -| | | v -0.08 -0.08 -0.08 -| | | v -0.08 0.08 -0.08 -| | | v 0.08 0.08 -0.08 -| | | v 0.08 0.08 0.08 -| | | f 2 1 6 5 -| | | f 3 2 5 4 -| | | f 2 3 8 1 -| | | f 8 3 4 7 -| | | f 5 6 7 4 -| | | f 1 8 7 6 | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| new | | send> new | -| | | +OK | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Command | Examples | ++==============================================================+=======================================================================================================================================================================================================+ +| listWindow | | send> listwindow | +| | | +OK | +| | | {658cac48-4cc4-42bf-a561-dbd28330777e} Dust3D%201.0.0-beta.17%20* | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| selectWindow | | send> selectwindow {658cac48-4cc4-42bf-a561-dbd28330777e} | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| undo | | send> undo | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| redo | | send> redo | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| paste | | send> paste | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| removeNode | | send> removeNode {3dc475f6-dcda-45b8-bb76-59948db39968} | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| removeEdge | | send> removeEdge {a75f39ac-3c78-4754-b34a-dce70779832b} | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| removePart | | send> removePart {79a15562-908c-4b74-a489-af604796b1a0} | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| addNode | | send> addNode 0.51 0.51 1.01 0.08 | +| | | +OK | +| | | | +| | | send> addNode 0.51 0.51 1.01 0.08 {3dc475f6-dcda-45b8-bb76-59948db39968} | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| addNodeWithId | | send> addNodeWithId {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.51 0.51 1.01 0.08 | +| | | +OK | +| | | | +| | | send> addNodeWithId {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.51 0.51 1.01 0.08 {3dc475f6-dcda-45b8-bb76-59948db39968} | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| scaleNodeByAddRadius | | send> scaleNodeByAddRadius {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.05 | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| moveNodeBy | | send> moveNodeBy {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.05 0.05 0.05 | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| setNodeOrigin | | send> setNodeOrigin {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.51 0.51 1.01 | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| setNodeRadius | | send> setNodeRadius {8d443cbf-fc73-4281-b3a1-268dd38b1c73} 0.08 | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| setNodeBoneMark | | Available bone marks: Neck/Limb/Tail/Joint/None | +| | | | +| | | send> setNodeBoneMark {8d443cbf-fc73-4281-b3a1-268dd38b1c73} Neck | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| switchNodeXZ | | send> switchNodeXZ {8d443cbf-fc73-4281-b3a1-268dd38b1c73} | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| moveOriginBy | | send> moveOriginBy 0.01, 0.02, 0.013 | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| addEdge | | send> addEdge {a75f39ac-3c78-4754-b34a-dce70779832b} {507328fd-9baf-41d1-9e05-850fb41fcbfa} | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| setPartLockState | | send> setPartLockState {79a15562-908c-4b74-a489-af604796b1a0} locked | +| | | +OK | +| | | | +| | | send> setPartLockState {79a15562-908c-4b74-a489-af604796b1a0} unlocked | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| setPartVisibleState | | send> setPartVisibleState {79a15562-908c-4b74-a489-af604796b1a0} visible | +| | | +OK | +| | | | +| | | send> setPartVisibleState {79a15562-908c-4b74-a489-af604796b1a0} invisible | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| setPartSubdivState | | send> setPartSubdivState {79a15562-908c-4b74-a489-af604796b1a0} subdived | +| | | +OK | +| | | | +| | | send> setPartSubdivState {79a15562-908c-4b74-a489-af604796b1a0} unsubdived | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| setPartChamferState | | send> setPartChamferState {79a15562-908c-4b74-a489-af604796b1a0} chamfered | +| | | +OK | +| | | | +| | | send> setPartChamferState {79a15562-908c-4b74-a489-af604796b1a0} unchamfered | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| setPartRoundState | | send> setPartRoundState {79a15562-908c-4b74-a489-af604796b1a0} rounded | +| | | +OK | +| | | | +| | | send> setPartRoundState {79a15562-908c-4b74-a489-af604796b1a0} unrounded | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| setPartDisableState | | send> setPartDisableState {79a15562-908c-4b74-a489-af604796b1a0} disabled | +| | | +OK | +| | | | +| | | send> setPartDisableState {79a15562-908c-4b74-a489-af604796b1a0} undisabled | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| setPartXmirrorState | | send> setPartXmirrorState {79a15562-908c-4b74-a489-af604796b1a0} mirrored | +| | | +OK | +| | | | +| | | send> setPartXmirrorState {79a15562-908c-4b74-a489-af604796b1a0} unmirrored | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| setPartColor | | send> setPartColor {79a15562-908c-4b74-a489-af604796b1a0} red | +| | | +OK | +| | | | +| | | send> setPartColor {79a15562-908c-4b74-a489-af604796b1a0} | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| getNodePartId | | send> getNodePartId {3dc475f6-dcda-45b8-bb76-59948db39968} | +| | | +OK | +| | | {b8f9ae53-999c-4851-9c2b-69a427fca10c} | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| saveSnapshot | | send> saveSnapshot | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| getSnapshot | | send> getSnapshot | +| | | +OK | +| | | | +| | | | +| | | | +| | | | +| | | | +| | | | +| | | | +| | | | +| | | | +| | | | +| | | | +| | | | +| | | | +| | | | +| | | | +| | | | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| exportAsObj | | send> exportAsObj | +| | | +OK | +| | | # DUST3D | +| | | v -0.08 0.08 0.08 | +| | | v -0.08 -0.08 0.08 | +| | | v 0.08 -0.08 0.08 | +| | | v 0.08 -0.08 -0.08 | +| | | v -0.08 -0.08 -0.08 | +| | | v -0.08 0.08 -0.08 | +| | | v 0.08 0.08 -0.08 | +| | | v 0.08 0.08 0.08 | +| | | f 2 1 6 5 | +| | | f 3 2 5 4 | +| | | f 2 3 8 1 | +| | | f 8 3 4 7 | +| | | f 5 6 7 4 | +| | | f 1 8 7 6 | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| new | | send> new | +| | | +OK | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Events @@ -308,9 +311,9 @@ Events +--------------------------------------------------------------+ | radiuslockstatechanged | +--------------------------------------------------------------+ -| checkpart | +--------------------------------------------------------------+ -| partchecked | +--------------------------------------------------------------+ | partunchecked | +--------------------------------------------------------------+