Uni OSC.Manual

User Manual:

Open the PDF directly: View PDF .
Page Count: 122

Download
Open PDF In Browser	View PDF

UniOSC Manual
vers. 1.5

Contents

1

Introduction

1

2

Installation

3

3

UniOSC main components

5

3.1

OSCEditor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5

3.2

OSCConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6

3.3

OSC Mapping file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6

3.4

OSCMappingItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7

3.5

OSC Session file

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7

3.6

OSCEventTarget

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7

3.7

OSCEventDispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8

4

5

6

UniOSC Editor Interface

9

4.1

Trace OSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

9

4.2

OSC Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

10

4.3

OSC Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

12

4.4

OSC Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13

4.5

Learn OSC

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15

4.6

Editor Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

16

Basic workflow (with TouchOSC)

17

5.1

Setup a OSC connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17

5.2

Setup TouchOSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17

5.3

Test communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17

5.4

Map OSC data (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17

5.5

Handle data in Unity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

18

Components

19

6.1

Example Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20

6.1.1

Toggle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20

6.1.2

Change Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21

6.1.3

Scale GameObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

iv

7

CONTENTS

6.1.4

Rotate GameObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

6.1.5

Move GameObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

23

6.1.6

TouchOSC Gyro Rotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

23

6.1.7

Send Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

24

6.1.8

OSC GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

24

6.1.9

Transform Sender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25

6.1.10 JavaScript Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25

Scripting classes

27

7.1

Receiving OSC data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27

7.1.1

27

7.2

Constructors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Sending OSC data
7.2.1

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

28

Constructors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

28

8

Common pitfalls

29

9

Known Issues

31

10 History

33

11 Credits

37

12 Links

39

13 Support

41

14 Namespace Documentation

43

14.1 Package UniOSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43

14.2 Package UnityEngine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

44

15 Class Documentation

45

15.1 UnityEngine.GUIScaler Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15.1.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.1.2 Member Function Documentation

45
45

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

45

15.1.2.1 Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

45

15.1.2.2 End . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

15.1.2.3 Initialize

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

15.1.2.4 Initialize

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

15.1.3 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

15.1.3.1 GuiScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

15.2 UniOSC.UniOSCAbstractItem Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . .

46

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

15.2.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

15.2.1 Detailed Description

15.2.2.1 address

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

Generated for monoflow by Doxygen

CONTENTS

v

15.2.2.2 isLearning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

15.3 UniOSCAutoRun Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

15.4 UniOSC.UniOSCChangeColor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

15.4.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.4.2 Member Function Documentation

47

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

47

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

47

15.4.2.2 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

47

15.4.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48

15.4.3.1 B_Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48

15.4.3.2 G_Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48

15.4.3.3 R_Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48

15.4.3.4 sharedMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48

15.5 UniOSC.UniOSCChangeColorEditor Class Reference . . . . . . . . . . . . . . . . . . . . . . . .

48

15.4.2.1 OnEnable

15.5.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48

15.5.1.1 OnInspectorGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48

15.6 UniOSCClassBasedDemo Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48

15.6.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.1 Light1

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.2 Light2

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.3 Light3

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.4 OSCAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.5 OSCAddressOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.6 OSCConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.7 OSCConnectionOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.8 OSCIPAddressOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.9 OSCPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.10 OSCPortOUT

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.11 sendData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.6.2.12 sendInterval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.7 UniOSC.UniOSCConnection Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

15.7.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.7.2 Member Function Documentation

51

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

51

15.7.2.1 Awake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

51

15.7.2.2 ConnectOSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

51

15.7.2.3 ConnectOSCOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

51

15.7.2.4 DisconnectOSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

51

15.7.2.5 DisconnectOSCOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

51

15.7.2.6 Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

51

15.7.2.7 RenderGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

Generated for monoflow by Doxygen

vi

CONTENTS

15.7.2.8 SendOSCMessage

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.2.9 SendSessionData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.2.10 SendTestMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.2.11 Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.2.12 Update_AvailablePorts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.3.1 autoConnectOSCIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.3.2 autoConnectOSCOut

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.3.3 dispatchOSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.3.4 dispatchOSCOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.3.5 foldoutOSCIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.3.6 foldoutOSCOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.3.7 isEditorEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.3.8 isOSCLearning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.3.9 localIPAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

15.7.3.10 oscMappingFileObjList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.3.11 oscOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.3.12 oscOutIPAddress

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.3.13 oscOutPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.3.14 oscPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.3.15 oscSessionFileObjList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.3.16 redrawFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.3.17 SendSessionDataOnStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.4 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.4.1 AvailableINPorts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.4.2 AvailableOUTIPAddresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.4.3 AvailableOUTPorts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.4.4 hasOSCMappingFileAttached . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.4.5 hasOSCSessionFileAttached . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.4.6 Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.4.7 isConnected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.4.8 isConnectedOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.5 Event Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.5.1 ConnectionInStatusChange . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.5.2 ConnectionOutStatusChange . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.5.3 OSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.5.4 OSCMessageReceivedRaw . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.7.5.5 OSCMessageSend

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.8 UniOSC.UniOSCConnectionEditor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . .

53

15.8.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

Generated for monoflow by Doxygen

CONTENTS

vii

15.8.1.1 ForceUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

15.8.1.2 LoadTextures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

15.8.1.3 OnInspectorGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

15.8.1.4 Show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

15.8.1.5 ShowOSCReciverStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

15.8.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

15.8.2.1 texOFF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

15.8.2.2 texON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

15.8.2.3 texTestMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

15.9 UniOSC.UniOSCEditor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

15.9.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.9.2 Member Function Documentation

55

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55

15.9.2.1 Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55

15.9.2.2 OnDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55

15.9.2.3 OnEnable

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55

15.9.2.4 OnHierarchyChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55

15.9.2.5 OSCLearning

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55

15.9.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

56

15.9.3.1 TRACEWIDTH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

56

15.9.4 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

56

15.9.4.1 Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

56

15.9.4.2 IsOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

56

15.9.4.3 isOSCLearning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

56

15.9.5 Event Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

56

15.9.5.1 OSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

56

15.10UniOSC.UniOSCEditorConfigObj Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . .

56

15.10.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.10.2 Member Function Documentation

57

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.1 configTraceScrollpos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.2 isEditorEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.3 isLastMessageTracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.4 isOSCLearning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.5 isOSCTracing

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.6 learnStyle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.7 mySkin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.8 OSCMappingFileObjList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.9 OSCSessionFileObjList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.10selectedMappingFileObjIndex . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.2.1 OnEnable

Generated for monoflow by Doxygen

viii

CONTENTS

15.10.3.11selectedSessionFileObjIndex . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.12tex_LearnFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.13tex_logo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.10.3.14toolbarInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.11UniOSC.UniOSCEventArgs Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

15.11.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.11.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.11.2.1 UniOSCEventArgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.11.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.11.3.1 IPAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.11.4 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.11.4.1 Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.11.4.2 AddressIndex

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.11.4.3 AddressRoot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.11.4.4 Group

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.11.4.5 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.11.4.6 Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

15.12UniOSC.UniOSCEventDispatcher Class Reference
15.12.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . .

58

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

59

15.12.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.1 _ConnectToOSCConnections . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.2 _DisconnectFromOSCConnections . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.3 _OnConnectionOutStatusChanged . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.4 _OnTimedEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.5 _SendOSCMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.6 _SetupOSCMessage

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.7 _Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.8 AppendData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.9 Awake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.10ClearData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.11OnDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.12OnDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.13OnEnable

60

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.12.2.14SendOSCMessage

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.15Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.16StartSendIntervalTimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.2.17StopSendIntervalTimer

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.3.1 _drawDefaultInspector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

15.12.3.2 _isOSCDirty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

Generated for monoflow by Doxygen

CONTENTS

ix

15.12.3.3 _mylock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

15.12.3.4 _OSCeArg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

15.12.3.5 _OSCmsg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

15.12.3.6 _sendIntervalTimer

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

15.12.3.7 explicitConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

15.12.3.8 oscOutAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

15.12.3.9 oscOutIPAddress

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

15.12.3.10oscOutPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

15.12.3.11sendInterval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

15.12.3.12useExplicitConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

15.13UniOSC.UniOSCEventDispatcherButton Class Reference . . . . . . . . . . . . . . . . . . . . . .

61

15.13.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.13.2 Member Function Documentation

62

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

15.13.2.1 Awake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

15.13.2.2 OnDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

15.13.2.3 OnEnable

62

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.13.2.4 SendOSCMessageDown

. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

15.13.2.5 SendOSCMessageUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

15.13.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

15.13.3.1 downOSCDataValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

15.13.3.2 showGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

15.13.3.3 upOSCDataValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

15.13.3.4 xPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

15.13.3.5 yPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

15.14UniOSC.UniOSCEventDispatcherButtonEditor Class Reference . . . . . . . . . . . . . . . . . . .

62

15.14.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.14.2 Member Function Documentation

63

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

15.14.2.2 OnInspectorGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

15.14.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

15.14.3.1 downOSCDataValueProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

15.14.3.2 ShowGUIProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

15.14.3.3 upOSCDataValueProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

15.14.3.4 xProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

15.14.3.5 yProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

15.15UniOSC.UniOSCEventDispatcherCB Class Reference . . . . . . . . . . . . . . . . . . . . . . . .

63

15.15.1 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.1.1 UniOSCEventDispatcherCB . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.1.2 UniOSCEventDispatcherCB . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

15.14.2.1 OnEnable

15.15.2 Member Function Documentation
Generated for monoflow by Doxygen

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

x

CONTENTS

15.15.2.1 _ConnectToOSCConnections . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.2.2 _DisconnectFromOSCConnections . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.2.3 _OnConnectionOutStatusChanged . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.2.4 _OnTimedEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.2.5 _SendOSCMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.2.6 _SetupOSCMessage

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.2.7 AppendData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.2.8 Awake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.2.9 ClearData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.2.10Disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

15.15.2.11Dispose

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.2.12Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.2.13OnDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.2.14SendOSCMessage

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.2.15SetExplicitConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.2.16StartSendIntervalTimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.2.17StopSendIntervalTimer

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.3.1 _isOSCDirty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.3.2 _mylock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.3.3 _OSCeArg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.3.4 _OSCmsg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.3.5 _sendIntervalTimer

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.3.6 sendInterval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.4 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.4.1 explicitConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.4.2 isEnabled

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

15.15.4.3 oscOutAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

67

15.15.4.4 oscOutIPAddress

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

67

15.15.4.5 oscOutPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

67

15.15.4.6 useExplicitConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

67

15.16UniOSC.UniOSCEventDispatcherCBImplementation Class Reference . . . . . . . . . . . . . . . .

67

15.16.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

67

15.16.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

67

15.16.2.1 UniOSCEventDispatcherCBImplementation . . . . . . . . . . . . . . . . . . . .

67

15.16.2.2 UniOSCEventDispatcherCBImplementation . . . . . . . . . . . . . . . . . . . .

68

15.16.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

68

15.16.3.1 Awake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

68

15.16.3.2 Disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

68

15.16.3.3 Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

68

Generated for monoflow by Doxygen

CONTENTS

xi

15.16.3.4 SetDataAtIndex0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

68

15.17UniOSC.UniOSCEventDispatcherEditor Class Reference . . . . . . . . . . . . . . . . . . . . . .

68

15.17.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.1.1 DrawConnectionInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.1.2 DrawIPAddress

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.1.3 DrawPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.1.4 OnEnable

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.1.5 OnInspectorGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.1.6 Show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.2.1 _myOSCConnectionsProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.2.2 _options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.2.3 _portIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.2.4 _target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.2.5 _tex_logo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.2.6 drawDefaultInspectorProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.2.7 ExplicitConnectionProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

15.17.2.8 OSCConnectionsProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

70

15.17.2.9 OSCOutAddressProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

70

15.17.2.10OSCOutIPAddressProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

70

15.17.2.11OSCOutPortProp

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

70

15.17.2.12OSCOutProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

70

15.17.2.13UseExplicitConnectionProp . . . . . . . . . . . . . . . . . . . . . . . . . . . .

70

15.18UniOSC.UniOSCEventDispatcherImplementation Class Reference . . . . . . . . . . . . . . . . .

70

15.18.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.18.2 Member Function Documentation

70

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

15.18.2.1 Awake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

15.18.2.2 MySendOSCMessageTrigerMethod . . . . . . . . . . . . . . . . . . . . . . . .

71

15.18.2.3 OnDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

15.18.2.4 OnEnable

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

15.18.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

15.18.3.1 dynamicFloatValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

15.18.3.2 dynamicIntValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

15.18.3.3 dynamicStringValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

15.19UniOSC.UniOSCEventTarget Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

15.19.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.19.2 Member Function Documentation

72

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

72

15.19.2.1 _ConnectToDispatchers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

72

15.19.2.2 _DisconnectFromDispatchers . . . . . . . . . . . . . . . . . . . . . . . . . . .

72

15.19.2.3 _OnConnectionInStatusChanged . . . . . . . . . . . . . . . . . . . . . . . . .

72

Generated for monoflow by Doxygen

xii

CONTENTS

15.19.2.4 OnDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

72

15.19.2.5 OnDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

72

15.19.2.6 OnEnable

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.2.7 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.2.8 Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.2.9 Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.3.1 _foldoutList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.3.2 _oscAddresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.3.3 _redrawFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.3.4 ConnectToDict . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.3.5 explicitConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.3.6 oscAddress

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.3.7 oscPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.3.8 receiveAllAddresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

15.19.3.9 receiveAllPorts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

74

15.19.3.10useExplicitConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

74

15.19.4 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

74

15.19.4.1 GetOSCAddresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

74

15.19.5 Event Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

74

15.19.5.1 OSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

74

15.20UniOSC.UniOSCEventTargetCB Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . .

74

15.20.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

15.20.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

15.20.2.1 UniOSCEventTargetCB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

15.20.2.2 UniOSCEventTargetCB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

15.20.2.3 UniOSCEventTargetCB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

15.20.2.4 UniOSCEventTargetCB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

15.20.2.5 UniOSCEventTargetCB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

15.20.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

15.20.3.1 Awake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

15.20.3.2 Disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

15.20.3.3 Dispose

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

15.20.3.4 Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.3.5 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.3.6 SetExplicitConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.4.1 _oscAddresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.4.2 ConnectToDict . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.5 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

Generated for monoflow by Doxygen

CONTENTS

xiii

15.20.5.1 explicitConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.5.2 isEnabled

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.5.4 oscPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.5.5 receiveAllAddresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.5.6 receiveAllPorts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.5.7 useExplicitConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.6 Event Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.20.6.1 OSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

15.21UniOSC.UniOSCEventTargetCBImplementation Class Reference . . . . . . . . . . . . . . . . . .

76

15.20.5.3 oscAddress

15.21.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

77

15.21.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

77

15.21.2.1 UniOSCEventTargetCBImplementation . . . . . . . . . . . . . . . . . . . . . .

77

15.21.2.2 UniOSCEventTargetCBImplementation . . . . . . . . . . . . . . . . . . . . . .

77

15.21.2.3 UniOSCEventTargetCBImplementation . . . . . . . . . . . . . . . . . . . . . .

77

15.21.2.4 UniOSCEventTargetCBImplementation . . . . . . . . . . . . . . . . . . . . . .

77

15.21.2.5 UniOSCEventTargetCBImplementation . . . . . . . . . . . . . . . . . . . . . .

77

15.21.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

77

15.21.3.1 Awake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

77

15.21.3.2 Disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

78

15.21.3.3 Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

78

15.21.3.4 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

78

15.22UniOSC.UniOSCEventTargetEditor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . .

78

15.22.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.1.1 DrawConnectionInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.1.2 DrawConnectionSetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.1.3 DrawPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.1.4 OnEnable

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.1.5 OnInspectorGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.1.6 ShowFoldoutConnectionStatus . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2.1 _options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2.2 _portIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2.3 _target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2.4 _tex_logo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2.5 AvailableINPortsProp

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2.6 ExplicitConnectionProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2.7 FoldoutListProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2.8 OSCAddressProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2.9 OSCPortProp

79

Generated for monoflow by Doxygen

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

xiv

CONTENTS

15.22.2.10ReceiveAllAddressesProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2.11ReceiveAllPortsProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.22.2.12UseExplicitConnectionProp . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

15.23UniOSC.UniOSCEventTargetImplementation Class Reference . . . . . . . . . . . . . . . . . . . .

80

15.23.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.23.2 Member Function Documentation

80

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

80

15.23.2.1 OnDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

80

15.23.2.2 OnEnable

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

80

15.23.2.3 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

81

15.23.2.4 Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

81

15.23.2.5 Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

81

15.24UniOSC.UniOSCFileObj Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

81

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

81

15.24.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

81

15.24.2.1 IsLearning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

81

15.24.2.2 my_guid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

15.24.2.3 scrollpos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

15.24.2.4 scrollposInspector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

15.24.3 Event Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

15.24.1 Detailed Description

15.24.3.1 OSCMessageSend

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

15.25UniOSC.UniOSCGUI Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

15.25.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

15.25.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

15.25.2.1 ShowInEditMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

15.25.2.2 traceMessages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

15.26UniOSC.UniOSCMappingFileObj Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . .

82

15.26.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.26.2 Member Function Documentation

83

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

83

15.26.2.1 AddOSCMappingItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

83

15.26.2.2 OnEnable

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

83

15.26.2.3 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

83

15.26.2.4 RemoveOSCMappingItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

83

15.26.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84

15.26.3.1 oscMappingItemList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84

15.27UniOSC.UniOSCMappingFileObjEditor Class Reference . . . . . . . . . . . . . . . . . . . . . . .

84

15.27.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84

15.27.1.1 Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84

15.27.1.2 OnGUI_OSCMappingData_Editor . . . . . . . . . . . . . . . . . . . . . . . . .

84

15.27.1.3 OnGUI_OSCMappingData_Inspector . . . . . . . . . . . . . . . . . . . . . . .

84

15.27.1.4 OnInspectorGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84

Generated for monoflow by Doxygen

CONTENTS

xv

15.27.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84

15.27.2.1 style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84

15.28UniOSC.UniOSCMappingItem Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . .

84

15.28.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

15.28.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

15.28.2.1 UniOSCMappingItem

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

15.28.2.2 UniOSCMappingItem

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

15.28.3.1 MapData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

15.28.3.2 OnOSCMappingItemDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

15.28.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.28.3 Member Function Documentation

15.28.4.1 address

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.28.4.2 collapsed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.28.4.3 hostObj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.28.4.4 isLearning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.28.4.5 mappingMAX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.28.4.6 mappingMIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.28.4.7 max

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.28.4.8 MAXHEIGTH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.28.4.9 MAXWIDTH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.28.4.10min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.29UniOSC.UniOSCMappingItemEditor Class Reference . . . . . . . . . . . . . . . . . . . . . . . .

86

15.29.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.29.1.2 OnGUI_Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.29.1.3 OnGUI_Inspector

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.30UniOSC.UniOSCMoveGameObject Class Reference . . . . . . . . . . . . . . . . . . . . . . . . .

86

15.29.1.1 OnEnable

15.30.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

87

15.30.2 Member Enumeration Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . .

87

15.30.2.1 Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

87

15.30.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

87

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

87

15.30.3.2 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

15.30.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

15.30.4.1 movementMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

15.30.4.2 nearClipPlaneOffset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

15.30.4.3 transformToMove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

15.30.3.1 OnEnable

15.31UniOSC.UniOSCReceiver Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

15.31.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

15.31.1 Detailed Description

Generated for monoflow by Doxygen

xvi

CONTENTS

15.31.2.1 UniOSCReceiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

15.31.2.2 UniOSCReceiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

15.31.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

89

15.31.3.1 Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

89

15.31.3.2 Disconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

89

15.31.4 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

89

15.31.4.1 FrameNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

89

15.31.4.2 Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

89

15.31.5 Event Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

89

15.31.5.1 OSCErrorOccured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

89

15.31.5.2 OSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

89

15.32UniOSC.UniOSCRotateGameObject Class Reference . . . . . . . . . . . . . . . . . . . . . . . .

89

15.32.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.32.2 Member Function Documentation

90

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

15.32.2.2 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

15.32.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

15.32.3.1 transformToRotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

15.32.3.2 X_Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

15.32.3.3 x_RotationFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

15.32.3.4 Y_Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

15.32.3.5 y_RotationFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

15.32.3.6 Z_Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

15.32.3.7 z_RotationFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

15.33UniOSC.UniOSCRotateGameObjectEditor Class Reference . . . . . . . . . . . . . . . . . . . . .

90

15.32.2.1 OnEnable

15.33.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

91

15.33.1.1 OnInspectorGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

91

15.34UniOSC.UniOSCRotateGameObjectTouchOSCGyro Class Reference . . . . . . . . . . . . . . . .

91

15.34.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

91

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

92

15.34.1.2 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

92

15.34.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

92

15.34.2.1 damping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

92

15.34.2.2 transformToRotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

92

15.34.2.3 x_RotationFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

92

15.34.2.4 y_RotationFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

92

15.34.2.5 z_RotationFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

92

15.34.1.1 OnEnable

15.35UniOSC.UniOSCScaleGameObject Class Reference
15.35.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . .

92

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93

15.35.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93

Generated for monoflow by Doxygen

CONTENTS

xvii

15.35.2.1 OnEnable

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93

15.35.2.2 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93

15.35.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93

15.35.3.1 scaleFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93

15.35.3.2 transformToScale

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93

15.36UniOSC.UniOSCScriptTestEditor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . .

93

15.36.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.36.2 Member Function Documentation

94

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

94

15.36.2.1 OnDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

94

15.36.2.2 OnEnable

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

94

15.36.3 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

94

15.36.3.1 Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

94

15.36.3.2 IsOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

94

15.37UniOSC.UniOSCSessionFileObj Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . .

94

15.37.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.37.2 Member Function Documentation

95

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

95

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

95

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

95

15.37.2.3 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

95

15.37.2.4 RemoveOSCSessionItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

95

15.37.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

95

15.37.2.1 AddOSCSessionItem
15.37.2.2 OnEnable

15.37.3.1 oscSessionItemList

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

95

15.38UniOSC.UniOSCSessionFileObjEditor Class Reference . . . . . . . . . . . . . . . . . . . . . . .

95

15.38.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

96

15.38.1.1 Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

96

15.38.1.2 OnGUI_OSCSessionData_Editor . . . . . . . . . . . . . . . . . . . . . . . . .

96

15.38.1.3 OnGUI_OSCSessionData_Inspector . . . . . . . . . . . . . . . . . . . . . . .

96

15.38.1.4 OnInspectorGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

96

15.38.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

96

15.38.2.1 style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

96

15.39UniOSC.UniOSCSessionItem Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . .

96

15.39.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.2.1 UniOSCSessionItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.2.2 UniOSCSessionItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.39.3.1 OnOSCSessionItemDelete

97

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.4.1 address

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.4.2 collapsed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

Generated for monoflow by Doxygen

xviii

CONTENTS

15.39.4.3 data

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.4.4 dataTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.4.5 hostObj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.4.6 isLearning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.4.7 MAXHEIGTH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.39.4.8 MAXWIDTH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

15.40UniOSC.UniOSCSessionItemEditor Class Reference

. . . . . . . . . . . . . . . . . . . . . . . .

97

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

98

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

98

15.40.1.2 OnGUI_Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

98

15.40.1.3 OnGUI_Inspector

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

98

15.41UniOSC.UniOSCToggle Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

98

15.40.1 Member Function Documentation
15.40.1.1 OnEnable

15.41.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15.41.2 Member Function Documentation

98

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

99

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

99

15.41.2.2 OnOSCMessageReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

99

15.41.2.3 UpdateComponentState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

99

15.41.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

99

15.41.3.1 componentToToggle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

99

15.41.3.2 toggleState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

99

15.42UniOSC.UniOSCToggleEditor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . .

99

15.41.2.1 OnEnable

15.42.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

15.42.1.1 ForceUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
15.42.1.2 OnEnable

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

15.42.1.3 OnInspectorGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
15.42.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
15.42.2.1 _componentIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
15.42.2.2 _targetToggle

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

15.42.2.3 _updateFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
15.42.2.4 ComponentToToggleProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
15.42.2.5 ToggleStateProp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
15.43UniOSC.UniOSCTransformSender Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . 100
15.43.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

15.43.1.1 _Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
15.43.1.2 OnDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
15.43.1.3 OnEnable

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

15.43.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
15.43.2.1 trackedGameObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
15.44UniOSC.UniOSCTransmitter Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
15.44.1 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Generated for monoflow by Doxygen

CONTENTS

xix

15.44.1.1 UniOSCTransmitter

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

15.44.1.2 UniOSCTransmitter

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

15.44.1.3 UniOSCTransmitter

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

15.44.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

15.44.2.1 Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
15.44.2.2 Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
15.44.2.3 SendOSCMessage

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

15.44.3 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
15.44.3.1 IPAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
15.44.3.2 Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
15.44.4 Event Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
15.44.4.1 OSCErrorOccured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Generated for monoflow by Doxygen

Chapter 1

Introduction
• UniOSC is a tool to easy create Unity applications which can be controlled by hard/software that uses the
OSC protocol for communication. OSC is a protocol for distributed systems that is mainly used in the music
industry and is often used as an alternative to MIDI. If you need more information about OSC please visit
http://opensoundcontrol.org/ . For the OSC communication UniOSC uses a modified version of
the OSCsharp library. You can use UniOSC to send/receive OSC messages to/from other devices that are
connected via Wi-Fi or create your own GUI-app for controlling another Unity application via OSC but it is
strongly recommended to use a third party software like TouchOSC for creating the GUI part. For more info
about TouchOSC please visit http://hexler.net
• UniOSC works in play- and edit-mode. That means you can check/setup your system without entering the
play mode of Unity. You could also use it to remote control the Editor.

2

Introduction

Generated for monoflow by Doxygen

Chapter 2

Installation
1. Import the UniOSC package from the Assetstore. You should now have a folder named UniOSC with the
following structure in your Unity project:

Figure 2.1: package structure

• Examples: UniOSC comes with a demo scene to show all components in a ready setup. For your mobile
device we provide the UniOSC.Mobile scene.
• Lib: Here is the OSCsharp dll located
• MappingFiles: Preconfigured mapping files for TouchOSC
• Scripts: All the c# code
2. After installation you should see a menu item under ‘ Window/UniOSC’. If there is no UniOSC menu item you
have to reimport the unitypackage or close & reopen Unity.
3. You should change the script execution order for the UniOSCConnection class in order to prevent problems
with auto connecting UniOSC components at start time. Go to “Edit/Project Settings/Script Execution Order”
and set the value for the UniOSCConnection class to a negative value so it is executed before other scripts.

4

Installation

Figure 2.2: Script Execution Order

4. For a quick test with a mobile device it is recommend getting the TouchOSC app. Or you make an app from
the UniOSC.Mobile scene and run it on your device.

Generated for monoflow by Doxygen

Chapter 3

UniOSC main components
3.1

OSCEditor

The OSC Editor is a tool to administrate your OSC setup in an easy and visual way and to speed up your workflow.
You have access to the main components and tools to create a working OSC setup. It is also very useful for tracing
the OSC data flow. For more info please look at UniOSC Editor Interface.

Figure 3.1: OSCEditor

6

3.2

UniOSC main components

OSCConnection
• The OSCConnection is a component that handles all the network related tasks of the OSC communication.
You can start listening on a local port for receiving incoming OSC data or open an OSC Out connection ready
to send data to an IP address on a given port.
• OSC IN: you can only specify the port the connection is listening on
• OSC OUT: You have to specify a port and IP address for outgoing OSC data.
• Connect On Start: If you select this option the connection is established automatically when your Unity app
starts or when you enter the play mode in the editor.

Figure 3.2: OSCConnection

3.3

OSC Mapping file
• The data of an OSC message is defined by your OSC sending application and so sometimes out of your
control. On the other side these values don’t comply with your workflow. It is useful to have some sort of
transformation of the data before it gets handled by your GameObject scripts. In this case you can create a
mapping file that you can attach to an OSC connection.
• The mapping file acts as a filter so the data of all the messages that are included in the mapping file are
mapped to new values before they pass through to the Unity GameObjects.
• A mapping file is a Scriptable Object asset that is located in your Assets folder so you can create one and
copy it to several Unity projects.
• For every OSC address you want to remap the data you have to create a mapping item entry in the mapping
file.
• UniOSC comes with some preconfigured mappings files to remap the default layouts that are included with
TouchOSC. They are located in ‘UniOSC/MappingFiles’.
Generated for monoflow by Doxygen

3.4 OSCMappingItem

3.4

7

OSCMappingItem
• A OSC message consists of an OSC Address Pattern followed by zero or more OSC Arguments that contain
the data in form of different data types .(For more info please look at the OSC Specification.)
• To map the data part of the message you first specify the range of the data when it arrives (min/max) and the
range to what it should be mapped (MapMin/MapMax).
• Normally the data comes in a normalized range from 0 to 1, or -1 to 1. It’s always a good practice to send
OSC data in this way when you create your own GUI app. You can map the values afterwards with the help
of a mapping file or remap the data in your OSCEventTarget components.

Figure 3.3: OSCMappingItem

3.5

OSC Session file
• When you work with a tool like TouchOSC you will realize that your GUI will reset when you start TouchOSC
after its task is suspended. To be able to set the GUI to the latest state from your Unity session it is possible
to store the last OSC data for a given OSC address.
• The OSC Session file is a container like a mapping file where you specify the addresses that should be stored.
After the file is attached to your OSC Connection you store the latest data that belongs to the addresses. You
are able to send all the data to your mobile device with one click so the GUI gets updated.(At the moment
only numbers&strings as data are supported).

3.6

OSCEventTarget

To handle OSC data on a Unity GameObject you can add a component that is derived from the abstract class OS←CEventTarget. It handles all the connections to the OSCConnection and the filtering, so you can get the data and do
whatever you want with your GameObject. UniOSC comes with some premade components (look in the Scripts.←Examples folder). The OSCEventTargetImplementation class is good blueprint for your own implementations.

Figure 3.4: OSCEventTargetImplementation Inspector

Generated for monoflow by Doxygen

8

3.7

UniOSC main components

OSCEventDispatcher

This is the opposite component as it’s passing some message to a OSCconnection for sending it out to another
device.

Generated for monoflow by Doxygen

Chapter 4

UniOSC Editor Interface
• Open the OSC Editor under ‘Window/UniOSC/OSCEditor’

• At the top of the OSCEditor you see the main buttons:

Figure 4.1: OSCEditor

4.1

Trace OSC
• For tracing all incoming & outgoing OSC messages you can toggle the trace OSC button. If you trace a text
field appears on the right side of the editor which displays all the OSC messages that Unity receives/send.

• Before Unity can receive/ send OSC data you have to turn on the OSC connections with the ports you want
to listen/send to.

• You can clear the content of the text field or use the ‘Display only last message‘ option (useful when your get
a constant data stream like info from a Gyro).

10

UniOSC Editor Interface

Figure 4.2: Tracing

4.2

OSC Connections

• The UniOSC Editor displays all OSCConnections that are in your project hierarchy currently enabled. If you
have any problems with an OSCConnection not displayed hit the ‘Refresh Editor’ button to force a rescan for
available OSCConnection instances.

• You see the same status boxes like in the Component Inspector. You can start and stop the connections but
if you want to administrate a connection you have to select the OSCConnection GameObject in the hierarchy
and work with the component inspector (Just click onto one of the status boxes and the OSCConnection get
selected in the project hierarchy for editing).
Generated for monoflow by Doxygen

4.2 OSC Connections

11

Figure 4.3: OSCConnection

• When an OSC connection is not connected it is displayed red. This means that no OSC data will be received/send.

Figure 4.4: OSCConnection ’off’

When you hit the connect button the connection establish the underlying network resources for communication. The connection box turns to green and a tiny button with a green status light appears.

Figure 4.5: OSCConnection ’on’

You’re now ready to go. In some circumstances it is useful to stop the message flow into Unity, but trace
Generated for monoflow by Doxygen

12

UniOSC Editor Interface

incoming OSC messages. In this case you can click on the status light to set the communication in a kind of
‘pause’ mode. You can trace the OSC data but the data is blocked and is not send to other GameObjects.
This is useful when you want to test your connections but don’t want that the properties of your GameObjects
are changed.

Figure 4.6: OSCConnection ’paused’

4.3

OSC Mapping
• You can attach multiple mapping files to an OSC Connection, but to prevent troubles with duplicated entries
that cause only confusion with overriding mapping values it is recommended to use only one mapping file for
an OSCConnection.

• To create a mapping file just click the ‘Create mapping file’ button in the editor or go to the Unity Editor menu
under GameObject/Create Other/UniOSC/OSC Mapping File.

• In the mapping area you see a dropdown list of all available mapping files in your project. The current selected
file is displayed below the dropdown list.

• If you want to attach a mapping file to a connection you can drop a mapping file asset from the Project Browser
onto the connection status boxes in the editor or in the component inspector. The other way is to click on the
path of the current displayed mapping file and drag to a connection box.

• If you want to add a mapping item entry to the current mapping file just hit the ‘Add OSC Mapping Item’ button
and a new empty mapping item is appended to the mapping file. (The address is left empty but the other
values are preconfigured with default values.

• To specify which message a mapping item is related to you enter a string into the OSC address text field or
you can enter the learn mode.

• If you have a mapping file and need most of the addresses from another file that already exists, you can add
all addresses from that file if you select an asset (mapping or session file) via the ‘add Items from file’ button.
You can also just drag&drop the file asset from the hierarchy onto the button.
Generated for monoflow by Doxygen

4.4 OSC Session

13

Figure 4.7: Mapping

4.4

OSC Session
• To store the latest data values that come with an OSC Message you can create a Session File. The behavior
to create and assign it to an OSC Connection is the same as with a Mapping File.

• When you added a Session File to an OSC Connection the last data of the specified addresses are now
stored to the file.

• The current values that are stored could be watched if you select the Session File from the popup. The first
four data values from an address are displayed. (Normally only one data value comes with a OSC message)

• When you attached a Session File to an OSC Connection a button ‘Send Session Data’ appears in the
component inspector. When you click the button (OSC Out Connection has to be enabled) all the data (OSC
messages) from the attached files is sent on the Out Connection. This is mainly for initialization of your GUI
(TouchOSC) useful, so all the elements are in sync with your last settings.
Generated for monoflow by Doxygen

14

UniOSC Editor Interface

Figure 4.8: Session

Generated for monoflow by Doxygen

4.5 Learn OSC

15

Figure 4.9: Session

4.5

Learn OSC

• In this mode a ‘learn’ button for every mapping/session item appears. If you push and the button the address
is set automatically to the address of the actual message that arrives on a port that you are listen to. So you
don’t need to write it by hand and can be sure of the right spelling.

• In learn mode the OSC data is not routed into Unity so you don’t have to think about if some values of your
Unity GameObjects are changed when you are in edit mode.
Generated for monoflow by Doxygen

16

UniOSC Editor Interface

Figure 4.10: Learn mode

4.6

Editor Mode
• A huge benefit of UniOSC is the possibility to work also in Edit mode so you don’t have to change to Play
mode if you want to test your data flow.
• When you disable this mode you can still trace your incoming data in the UniOSCEditor but the OSC data is
not routed any further.
• When you enable the Editor Mode you have to keep in mind that your incoming OSC data can change your
scene permanently! This mode is useful if you want to create some editor tools.

Generated for monoflow by Doxygen

Chapter 5

Basic workflow (with TouchOSC)
5.1

Setup a OSC connection
• Click the ‘Create OSC Connection’ button. You should see now the new created OSC connection in the editor.
• IN Connection: enter a port number of your choice (or use Port(outgoing) from TouchOSC).
• OUT Connection: specify the port (or use Port(incoming) from TouchOSC and the IP address (Local IP
address from your mobile device).

5.2

Setup TouchOSC
• Go to: Settings/Connections/OSC
• Host(target IP address): has to match with the local IP address of the computer running Unity.
• Port(outgoing): has to match with the OSC IN port of an OSCConnection.

5.3

Test communication
• Push the connect buttons to establish a OSC connection.
• Use the Trace option in the Editor to check if OSC data is received by Unity.
• Send some OSC data from your app on your mobile device. You should see now the OSC messages in the
trace text field. If you see nothing you have to check if your OSC connection is running, that your ports are
matching or if you have a reliable network connection.

5.4

Map OSC data (Optional)
• Create a OSC mapping file
• Create OSC mapping item
• Learn OSC for setting a mapping item

18

5.5

Basic workflow (with TouchOSC)

Handle data in Unity
• Attach one of the UniOSC scripting components to your GameObjects you want to control and specify the
address and port you want to listen to. (See Scripting classes for more info)
• If you stay in edit mode you have to be aware that if you have an open OSCConnection you can change right
now your GameObject properties via OSC live in the Unity editor!

Generated for monoflow by Doxygen

Chapter 6

Components
• To work with the OSC data inside Unity you have to add one of the components to your GameObject or write a
component by yourself, based on a base class that UniOSC provides. For easy access to the UniOSC editor
all component inspectors have a small icon at the top where you can click on to open the UniOSC editor.

• You always have to set the OSC address so the component can filter if a message should be handled respectively what OSC address should be sent.

• If you select the option ‘Listen to all Addresses’ your component receives all messages, this is handy if you
want to listen to multiple OSC addresses, but are too lazy to add every message to the _oscAddresses list in
code.

• All receiving components have in common that you have to specify the port you want to listen to. You can
listen on one port or use the ‘Listen on all Ports’ option where the component listens on all available IN ports
in your Scene.

• If you change a port the component reconnects it to the appropriate OSCConnection, so you can change
your port live without restarting your scene.

• As this approach is not so flexible when you change the settings on your OSCConnection frequently but want
to bind to only one specific port there is a third approach how you specify your binding:

• Explicit Connection. If you select this option you don’t have to specify a port but only select the OSC←Connection you want to bind to. Your component uses now always the actual port from your OSCConnection.
When you change the settings of your OSCConnection your components also bind to the new port or IP-←Address.

• In play mode the inspector gives you visual feedback to which port the component is actual listen to.

Figure 6.1: Listen to running connection

20

Components

Figure 6.2: Listen but connection not running

Figure 6.3: Not connected

• For receiving OSC Data you can use the UniOSCEventTarget class as a starting point to subclass from. The
main method you have to implement by yourself is the ‘OnOSCMessageReceived’ method
• Additionally to the OnOSCMessageReceived method calling on your subclass there is also the OSC←MessageReceived event fired to handle the data on other classes that subscribe to this event.
• We provide the UniOSCEventTargetImplementation class where you could see how your own class should
look like and what parsing possibilities you have.
• You can specify the data you want to send in your class implementation. With the AppendData(data) method
you add the data to your OSCMessage. You can add as much data as you want as long as the data type
is supported by the OSC protocol (Int32,Int64,Single,Double,String,Byte[],OscTimeTag,Char,Color,Boolean).
When you want to clear the data you can call the ClearData() method.
• For sending OSC Data you can create your own subclasses from the abstract class UniOSCEventDispatcher.
You specify an OSC address, the port and an IP address. (The UniOSCEventDispatcherImplementation class
is a good starting point for your own implementations.)
• If you need to send OSC Messages constantly (from an Input device for example) you can specify the “send←Interval” property were you set the interval in milliseconds the component should send OSC messages.
(Sending too much OSC Messages in a short timespan can cause transmission problems)

6.1

Example Components

Most of the example components are assuming that the OSC data comes in normalized values between 0 and 1.
It’s up to you how you want to remap the data. You can make a mapping item for the address and make so a global
remapping with a mapping file or you can remap the values on the component level with a scale factor.

6.1.1

Toggle

• This is a universal component to enable/disable most of the existing Unity components.
• With the ‘ComponentToToggle’ dropdown list you select one of the component types that are attached to the
current GameObject you want to toggle.
• The data of the OSC message you use should be 0(disabled) or 1 (enabled).
Generated for monoflow by Doxygen

6.1 Example Components

21

Figure 6.4: Toggle

6.1.2

Change Color

• For every color channel you can set a OSC address.
• The ‘Shared Material’ option is only in play mode relevant as in editor mode you always change the shared
material property (Changes are stored permanently). In play mode you normally change the material (If you
leave the play mode all changes are lost). If you are unfamiliar with the difference between material and
shared material please look at the Unity documentation.

Figure 6.5: ChangeColor

Generated for monoflow by Doxygen

22

Components

6.1.3

Scale GameObject

• You can specify a scale factor for your scaling. The incoming OSC data gets multiplied by the factor.

Figure 6.6: Scale GameObject

6.1.4

Rotate GameObject

• For every axis you set the OSC address and a rotation factor.

Figure 6.7: Rotate GameObject

Generated for monoflow by Doxygen

6.1 Example Components

6.1.5

23

Move GameObject

• In Screen Mode this component moves a GameObject in front of the main camera over the whole screen
area. It assumes an OSC message with data for x and y axis normalized. (Like the XY Pad from TouchOSC
. Just specify the offset from the near clipping plane from the camera. The object will move in front of the
camera.

• In Relative Mode the current data values are added to the current position. So you can move your object out
of the screen

Figure 6.8: Move GameObject

6.1.6

TouchOSC Gyro Rotate

• This component is for receiving the gyro data from a TouchOSC device. (Always use the ‘/accxyz’ string as
the OSC address)

• In TouchOSC you can turn on an option to send the accelerometer data from your device. (TouchOSC
Settings/Options/Accelerometer (/xyz))

• TouchOSC send the ‘/accxyz’ message now permanently.

• The data of every axis comes in the range from -1 to +1.
Generated for monoflow by Doxygen

24

Components

Figure 6.9: Gyro Rotate

6.1.7

Send Button

• With this component you can send an OSC message. You have to turn on the ‘Show GUI’ option to actually
see a GUI button on your screen otherwise it’s more of an abstract button you can trigger from other scripts.

Figure 6.10: Send Button

6.1.8

OSC GUI

• This component is intended for testing and debugging the OSCConnections on a running app and gives you
parts of the UniOSC editor functionality.
Generated for monoflow by Doxygen

6.1 Example Components

25

Figure 6.11: OSC GUI component

6.1.9

Transform Sender

• With this component you can send the transform data of a GameObject in a continuously way. If you don’t
specify a Tracked GameObject the current hosting GameObject is used.

6.1.10

JavaScript Communication

• UniOSC is written in C# so if you want to code in JS you have to know that there are some limitations. There
is only one direction of where the C# world can communicate with the JS world . This is a general problem
of Unity. So first you have to decide from which direction your communication should flow (C# -> JS or JS
-> C#. Depending on that the scripts of one Language must be located in the Plugins folder to be compiled
first. Look at http://docs.unity3d.com/Manual/ScriptCompileOrderFolders.html for
more info. To prevent a lot of trouble with compilation problems we only suggest that you use C# -> JS
communication so you only have to locate your JS scripts in the Plugins folder. We provide a JSBridge←Demo.unityPackage that installs a little demo scene with a demo setup that you can use as a starting point for
your own JS scripting. As we are limited in the way to send custom data types from C# to JS we have to parse
our OSC data before we can send only primitive types like int or strings and the one way communication we
Generated for monoflow by Doxygen

26

Components

strongly suggest to only script in C#!

Generated for monoflow by Doxygen

Chapter 7

Scripting classes
• Working with Components is easy and you have visual inspectors for the set up but if you need to handle
OSCData in classes that don’t derive from a MonoBehaviour or prefer to work mostly in pure code you can
use the class based versions of the OSCDispachers and OSCReceiver classes.
• The common handling for class based instances are:
1. Create a instance with calling one of the constructors. There are several class constructors you can use
to specify your type of instance like the way you can specify it on the component based versions. You
only have to override the constructors you want to use and call the base constructor of that type
2. Call instance.Enable(). Without enabling, the OSC data handling will not be initialized. Later the Enable()
methods could re-enable your instance when it is temporary disabled.
3. Call instance.Disable() if you want to disable the instance only temporary.
4. Call instance.Dispose() if you want to delete the instance. This is important to make sure that the On←OSCMessageReceived method isn’t called any further or none of your Event callbacks are still called,
even if your instance is set to null or the class that hosting your instance is destroyed.
• The UniOSCEventTargetCBImplementation and UniOSCEventDispatcherCBImplementation classes
are good blueprints for your own scripting
• If you want to use the class based scripts in a Unity Editor class you have to consider a couple of additional
steps. The problem is that your scripts will lose the references to the OSCConnections when you change
the playmode state of Unity. For the instances that don’t use the ExplicitConnection feature you only have
to re-enable your instance to force a new connection set up on your instance. For the other instances you
have to re-create a reference to the OSCConection from the InstanceID and call the SetExplicitConnection()
method. We provide a UniOSCTestEditor script that shows exactly what steps you have to do for your own
Editors.( In Unity go to: Window/UniOSC/Test/ScriptTestEditor)

7.1

Receiving OSC data

To create a class that needs to listen to an OSC Message you can create a class that is a subclass from the
UniOSCEventTargetCB class.

7.1.1

Constructors

You can choose between several constructors to get the same features you know from the component versions:
• UniOSCEventTargetCB(int oscPort)
Your instance auto connect to the first OSCConnection that has the given IN port and handles all OSC←Addresses

28

Scripting classes

• UniOSCEventTargetCB(string oscAddress)
Your instance auto connects to all available OSCConnections and handle all OSCMessages that match the
given OSCAddress
• UniOSCEventTargetCB(string oscAddress, int oscPort)
Your instance only react to a OSCMessage that comes from a given port with a given address pattern
• UniOSCEventTargetCB(UniOSCConnection con)
This is the Explicit Connection feature. You listen to all OSCMessages that come from a given OSC←Connection, regardless if the port is changed later.
• UniOSCEventTargetCB(string oscAddress, UniOSCConnection con)
Explicit Connection feature but you specify the OSCAddress pattern that you want to react to.

7.2

Sending OSC data

For sending data it is almost the same like receiving

7.2.1

Constructors

You can only choose between two constructors:
• UniOSCEventDispatcherCB(string oscOutAddress, string oscOutIPAddress,int oscPort )
The OSC data you have added are sent with the OSCOutAddress to a given IPAddress on a given port when
there is a OSCConnection with a matching IPAddress/port available
• UniOSCEventDispatcherCB(string oscOutAddress, UniOSCConnection explicitConnection)
An OSC Message is sent with a given OSCConnection. The current settings of the OSCConnection determine
the IPAddress/port

Generated for monoflow by Doxygen

Chapter 8

Common pitfalls
• If an OSCConnection is connected the port of the connection is in use, so no other OSC connection can
use this port. To prevent confusion it’s always a good practice to always use different ports for every OSC←Connection.
• If you use multiple mapping files on an OSCConnection are sure that the address spaces don’t overlap.
Otherwise only the mapping values of the last mapping file that is parsed will be used for remapping.
• The OSC message appears in the trace text field but my game objects don’t receive a message:
•

– Are you in learning mode?
– Is the OSCConnection paused?
– Check your port at the GameObject component.

• When you use the gyro data from TouchOSC other OSC controlled objects that listen on the same port can
begin to react sluggish. It’s best to use a separate device for the gyro and use another device on another port
for the other GameObjects.
• Depending on your network topology you will have a latency when you use your mobile device to send/receive
OSC data. To get the best performance we recommend setup an Ad-Hoc Network to get the lowest latency
for best user experience. See the Links section for further information.

30

Common pitfalls

Generated for monoflow by Doxygen

Chapter 9

Known Issues
• Only float/int data types are mappable
• Mapping files .assets cause issues when importing in a project with other Unity version from the version of
creation. Please read the ‘Read.Me.First!.txt’ file in the ‘Mapping Files’ folder.

32

Known Issues

Generated for monoflow by Doxygen

Chapter 10

History
Version 1.5 – 2015.02.27
• Unity 5 ready
• Added Editor Mode
– You have to enable the editor mode now explicit to route your OSC data to the Components.
• Changed the Component Inspector for Dispatchers and Receivers
– The base Inspectors are now drawing the DefaultInspector .
– You can now create your own scripts based on the UniOSCEventTarget & UniOSCEventDispatcher and
all public properties are displayed right out of the box. (You don’t need to write a custom inspector any
more to show your own public properties)
• Added a Mode option at UniOSCMoveGameObject.
– You have now a Screen mode (like before) and a Relative Mode (additive movement that is not bound
to the camera rect)
• Added a UniOSCTransformSender component for sending the transform data (position & rotation) of a
GameObjects continuously

Version 1.4 - 2014.11.24
• Class based versions of OSCEventTarget and OSCDispatcher. You can now handle OSC messages in
classes that don’t derive from MonoBehaviour. This makes it possible to work only in code and in editors.
• Created a demo editor to show the new class based feature to use in Unity Editors.
• Created a demo scene with class based sending and receiving.
• Fixed a bug with the explicit connection mode (OSC data of OSCEventDispatchers was always reset when a
status changed event was fired from a OSCConnection)
• Added a ClearData method to the OSCEventDispatcher class so you can clear the OSC data.
• Added an OSCMessageReceived event to the OSCEventTarget classes. This event is additionally fired when
the OnOSCMessageReceived method is called.
• Documentation update

34

History

Version 1.3 - 2014.11.07
• Added Explicit Connection mode for OSCEventTargets and OSCEventDispatchers.
• UniOSCGUI updated: You can now change the port and IP-Address in the GUI at runtime for a flexible setup.
• Mobile Example scene updated with new UniOSCGUI and added several components that use the Explicit
Connection.
• Added the JSBridgeDemo.unitypackage for showing how to send data to a JavaScript class.
• Documentation update

Version 1.2 - 2014.07.02
• UniOSCEventDispatcher can now send more than only one float value as data. You can add as much data as
you want as long as the data type is supported by the OSC protocol (Int32,Int64,Single,Double,String,Byte[],Osc←TimeTag,Char,Color,Boolean)
• Added a UniOSCEventDispatcherImplementation class as a blueprint for OSC sending components.
• Added External InputDevice scripts (Third party Assets need to be installed to work)
– Send OSC data with the SpacNavigator Controller (Asset from Patrik Hogenboom) : https←-

://www.assetstore.unity3d.com/en/#!/content/9774
– Send OSC data with Razor Hydra Controller from Sixsense Studios:

https://www.←-

assetstore.unity3d.com/en/#!/content/7953
• Unity 4.5 Bug fixed (Tracing of OSC messages causes an exception when there were more than 15000 chars
in the TextField. Tracing TextField now displays maximal 8192 chars.
• Documentation update

Version 1.1 - 2014.05.29
• Session file support
– Store the latest data that comes with a OSC message
– Send all data to update the GUI state of an external app like TouchOSC
• Change in OSCsharp lib: made the TypeTag property of a OSC message accessible
• Type of the data could now be verified with the Typetag string. No GetType() necessary if you have performance problems
• receiveAllAddresses property is now accessible via the component inspector
• UniOSCEventArgs could now be filtered by Group, AddressRoot or AddressIndex if the OSC address matches
a specific pattern
• Documentation update

Version 1.0 - 2014.05.13
Generated for monoflow by Doxygen

35

• Initial release

Generated for monoflow by Doxygen

36

History

Generated for monoflow by Doxygen

Chapter 11

Credits
UniOSC uses a modified version of OSCsharp written by Valentin Simonov based on Bespoke Open Sound Control
Library by Paul Varolik
• Original version https://github.com/valyard/OSCsharp
• Modified version: https://github.com/sloopidoopi/OSCsharp

• GuiScaler class from: https://gist.github.com/darktable/2018687
• TouchOSC by Hexler: http://hexler.net/software/touchosc

38

Credits

Generated for monoflow by Doxygen

Chapter 12

Links
• OSC: http://opensoundcontrol.org/spec-1_0
• TouchOSC control reference: http://hexler.net/docs/touchosc-controls-reference
• Establishing a Computer-to-Computer (Ad-Hoc) network without a router
Windows:

http://windows.microsoft.com/en-us/windows/set-computer-to-computer-adhoc-network#1←
TC=windows-7
OSX:

http://support.apple.com/kb/PH10666

40

Links

Generated for monoflow by Doxygen

Chapter 13

Support
If you need support or have any question/suggestions please contact us.
• Website: http://uniosc.monoflow.org
• Email: info@monoflow.org
• Unity Forum: http://forum.unity3d.com/threads/247204

Copyright © 2014 by

42

Support

Generated for monoflow by Doxygen

Chapter 14

Namespace Documentation
14.1

Package UniOSC

Classes
• class UniOSCAbstractItem
Uni OSC abstract item is the base class for Mapping/Session Items.

• class UniOSCChangeColor
Change the color of the material from the GameObjects.

• class UniOSCChangeColorEditor
• class UniOSCConnection
This class is responsible for all the network related tasks.

• class UniOSCConnectionEditor
• class UniOSCEditor
Editor for the administration of OSCconnections, mapping files.

• class UniOSCEditorConfigObj
UniOSC editor config object.

• class UniOSCEventArgs
A wrapper to a OscMessage class to also store the port and have a quick way to access the message address.

• class UniOSCEventDispatcher
This is the abstract class you should subclass from when you want to sent OSC data

• class UniOSCEventDispatcherButton
Dispatcher button that forces a OSCConnection to send a OSC Message.

• class UniOSCEventDispatcherButtonEditor
Uni OSC event dispatcher button editor.

• class UniOSCEventDispatcherCB
• class UniOSCEventDispatcherCBImplementation
This class is a blueprint for your own implementations of the abstract class UniOSCEventDispatcherCodeBased
Dispatcher forces a OSCConnection to send a OSC Message.

• class UniOSCEventDispatcherEditor
• class UniOSCEventDispatcherImplementation
This class is a blueprint for your own implementations of the abstract class UniOSCEventDispatcher Dispatcher forces
a OSCConnection to send a OSC Message.

• class UniOSCEventTarget
UniOSC event target.

• class UniOSCEventTargetCB
UniOSC event target for class based scripting.

• class UniOSCEventTargetCBImplementation

44

Namespace Documentation

This class is a blueprint for your own implementations of the abstract class OSCDispatcherTargetCB //Don’t forget the
base callings !!!! The OnOSCMessageReceived method is where you should parse the OSC data

• class UniOSCEventTargetEditor
• class UniOSCEventTargetImplementation
This class is a blueprint for your own implementations of the abstract class OSCDispatcherTarget //Don’t forget the
base callings !!!! The OnOSCMessageReceived method is where you should parse the OSC data

• class UniOSCFileObj
• class UniOSCGUI
GUI class that mimics the UniOSC editor interface for runtime use You can start/stop the OSCConnections and trace
OSC data messages

• class UniOSCMappingFileObj
Mapping file class .

• class UniOSCMappingFileObjEditor
• class UniOSCMappingItem
Uni OSC mapping item.

• class UniOSCMappingItemEditor
• class UniOSCMoveGameObject
Moves a GameObject in normalized coordinates (ScreenToWorldPoint)

• class UniOSCReceiver
Uni OSC receiver.

• class UniOSCRotateGameObject
Rotates (localRotation) the hosting game object.

• class UniOSCRotateGameObjectEditor
• class UniOSCRotateGameObjectTouchOSCGyro
• class UniOSCScaleGameObject
Uni OSC scale game object.

• class UniOSCScriptTestEditor
Editor for the administration of OSCconnections, mapping files.

• class UniOSCSessionFileObj
OSC Session file class .

• class UniOSCSessionFileObjEditor
• class UniOSCSessionItem
Uni OSC mapping item.

• class UniOSCSessionItemEditor
• class UniOSCToggle
With this class you can toggle most of the Unity Components on/off The data of the OSC message should be only
0(off) or 1(on)

• class UniOSCToggleEditor
• class UniOSCTransformSender
• class UniOSCTransmitter

14.2

Package UnityEngine

Classes
• class GUIScaler
Usage:

Generated for monoflow by Doxygen

Chapter 15

Class Documentation
15.1

UnityEngine.GUIScaler Class Reference

Usage:

Static Public Member Functions
• static void Initialize (float scale)
Initialize the gui scaler with a specific scale.

• static void Initialize ()
Initialize the gui scaler using the detected screen dpi.

• static void Begin ()
All gui elements drawn after this will be scaled.

• static void End ()
Restores the default gui scale.

Properties
• static Vector3 GuiScale [get]

15.1.1

Detailed Description

Usage:
(optional) Call GUIScaler.Initialize() in Start(), Awake() or OnEnable() (only needed once) Call GUIScaler.Begin() at
the top of your OnGUI() methods Call GUIScaler.End() at the bottom of your OnGUI() methods
WARNING: If you don’t match Begin() and End() strange things will happen.

15.1.2

Member Function Documentation

15.1.2.1

static void UnityEngine.GUIScaler.Begin ( ) [static]

All gui elements drawn after this will be scaled.

46

Class Documentation

15.1.2.2

static void UnityEngine.GUIScaler.End ( ) [static]

Restores the default gui scale.
All gui elements drawn after this will not be scaled.

15.1.2.3

static void UnityEngine.GUIScaler.Initialize ( float scale ) [static]

Initialize the gui scaler with a specific scale.

15.1.2.4

static void UnityEngine.GUIScaler.Initialize ( ) [static]

Initialize the gui scaler using the detected screen dpi.

15.1.3

Property Documentation

15.1.3.1

Vector3 UnityEngine.GUIScaler.GuiScale [static], [get]

15.2

UniOSC.UniOSCAbstractItem Class Reference

Uni OSC abstract item is the base class for Mapping/Session Items.

Public Attributes
• bool isLearning
• string address = ""

15.2.1

Detailed Description

Uni OSC abstract item is the base class for Mapping/Session Items.

15.2.2

Member Data Documentation

15.2.2.1

string UniOSC.UniOSCAbstractItem.address = ""

15.2.2.2

bool UniOSC.UniOSCAbstractItem.isLearning

15.3

UniOSCAutoRun Class Reference

15.4

UniOSC.UniOSCChangeColor Class Reference

Change the color of the material from the GameObjects.
Inheritance diagram for UniOSC.UniOSCChangeColor:
Generated for monoflow by Doxygen

15.4 UniOSC.UniOSCChangeColor Class Reference

47

MonoBehaviour
UniOSC.UniOSCEventTarget
UniOSC.UniOSCChangeColor

Public Member Functions
• override void OnEnable ()
Enable this component and reinitialize.

• override void OnOSCMessageReceived (UniOSCEventArgs args)
You should override this method in a subclass to handle the OSC data.

Public Attributes
• string R_Address
• string G_Address
• string B_Address
• bool sharedMaterial

Additional Inherited Members
15.4.1

Detailed Description

Change the color of the material from the GameObjects.
Option to choose between Material and SharedMaterial

15.4.2

Member Function Documentation

15.4.2.1

override void UniOSC.UniOSCChangeColor.OnEnable ( ) [virtual]

Enable this component and reinitialize.
If a property of the component is changed via the inspector we force a OnEnable to update the status of the
component. In general the component disconnects from all OSCConnections and try to find a new OSCConnection
to connect to with a matching port. If you change properties via code you should call this explicit.
Reimplemented from UniOSC.UniOSCEventTarget.

15.4.2.2

override void UniOSC.UniOSCChangeColor.OnOSCMessageReceived ( UniOSCEventArgs args ) [virtual]

You should override this method in a subclass to handle the OSC data.
Parameters
args

The current OSCEventArgs object

Implements UniOSC.UniOSCEventTarget.
Generated for monoflow by Doxygen

48

Class Documentation

15.4.3

Member Data Documentation

15.4.3.1

string UniOSC.UniOSCChangeColor.B_Address

15.4.3.2

string UniOSC.UniOSCChangeColor.G_Address

15.4.3.3

string UniOSC.UniOSCChangeColor.R_Address

15.4.3.4

bool UniOSC.UniOSCChangeColor.sharedMaterial

15.5

UniOSC.UniOSCChangeColorEditor Class Reference

Inheritance diagram for UniOSC.UniOSCChangeColorEditor:

Editor
UniOSC.UniOSCEventTargetEditor
UniOSC.UniOSCChangeColorEditor

Public Member Functions
• override void OnInspectorGUI ()

Additional Inherited Members
15.5.1

Member Function Documentation

15.5.1.1

override void UniOSC.UniOSCChangeColorEditor.OnInspectorGUI ( )

15.6

UniOSCClassBasedDemo Class Reference

Demo to show how to use the class based scripts.
Inheritance diagram for UniOSCClassBasedDemo:

MonoBehaviour
UniOSCClassBasedDemo

Public Attributes
•
•
•
•
•
•

string OSCAddress
int OSCPort
UniOSCConnection OSCConnection
string OSCAddressOUT
string OSCIPAddressOUT = "192.168.178.32"
int OSCPortOUT
Generated for monoflow by Doxygen

15.7 UniOSC.UniOSCConnection Class Reference

•
•
•
•
•
•

UniOSCConnection OSCConnectionOUT
Light Light1
Light Light2
Light Light3
bool sendData
float sendInterval =1000

15.6.1

Detailed Description

Demo to show how to use the class based scripts.

15.6.2

Member Data Documentation

15.6.2.1

Light UniOSCClassBasedDemo.Light1

15.6.2.2

Light UniOSCClassBasedDemo.Light2

15.6.2.3

Light UniOSCClassBasedDemo.Light3

15.6.2.4

string UniOSCClassBasedDemo.OSCAddress

15.6.2.5

string UniOSCClassBasedDemo.OSCAddressOUT

15.6.2.6 UniOSCConnection UniOSCClassBasedDemo.OSCConnection
15.6.2.7 UniOSCConnection UniOSCClassBasedDemo.OSCConnectionOUT
15.6.2.8

string UniOSCClassBasedDemo.OSCIPAddressOUT = "192.168.178.32"

15.6.2.9

int UniOSCClassBasedDemo.OSCPort

15.6.2.10

int UniOSCClassBasedDemo.OSCPortOUT

15.6.2.11

bool UniOSCClassBasedDemo.sendData

15.6.2.12

float UniOSCClassBasedDemo.sendInterval =1000

15.7

UniOSC.UniOSCConnection Class Reference

This class is responsible for all the network related tasks.
Inheritance diagram for UniOSC.UniOSCConnection:

MonoBehaviour
UniOSC.UniOSCConnection

Public Member Functions
• void Awake ()
• IEnumerator Start ()
Generated for monoflow by Doxygen

49

50

Class Documentation

• void ConnectOSC ()
creates internally an UniOSCReciver which handles all the Network setup.

• void DisconnectOSC ()
Disconnects and destroys the OSCConnection.

• void ConnectOSCOut ()
Connects the OSC out.

• void DisconnectOSCOut ()
Disconnects and release the OSC out connection.

• void RenderGUI ()
Renders the GUI of a OSCConnection in the GameView.

• void SendOSCMessage (object sender, UniOSCEventArgs args)
Sends the OSC message.

• void SendTestMessage ()
Sends the test message.

• void SendSessionData ()
Sends the session data.

Static Public Member Functions
• static void Init ()
Init this instance.

• static void Update_AvailablePorts ()
Updates the available ports.

Public Attributes
• bool autoConnectOSCIn = true
• int oscPort = 8000
• bool oscOut = true
• bool autoConnectOSCOut = true
• bool foldoutOSCOut = true
• bool foldoutOSCIn = true
• string oscOutIPAddress
• int oscOutPort = 9000
• bool redrawFlag
• bool dispatchOSC = true
• bool dispatchOSCOut = true
• List< UniOSCMappingFileObj > oscMappingFileObjList
• List< UniOSCSessionFileObj > oscSessionFileObjList
• bool SendSessionDataOnStart

Static Public Attributes
• static string localIPAddress = null
• static bool isOSCLearning = false
• static bool isEditorEnabled = false
Generated for monoflow by Doxygen

15.7 UniOSC.UniOSCConnection Class Reference

Properties
•
•
•
•
•
•
•
•

static List< UniOSCConnection > Instances [get]
static List< int > AvailableINPorts [get]
static List< int > AvailableOUTPorts [get]
static List< string > AvailableOUTIPAddresses [get]
bool isConnected [get]
bool isConnectedOut [get]
bool hasOSCMappingFileAttached [get]
bool hasOSCSessionFileAttached [get]

Events
•
•
•
•
•

EventHandler< UniOSCEventArgs > OSCMessageReceivedRaw
EventHandler< UniOSCEventArgs > OSCMessageReceived
EventHandler< UniOSCEventArgs > OSCMessageSend
Action< UniOSCConnection > ConnectionInStatusChange
Action< UniOSCConnection > ConnectionOutStatusChange

15.7.1

Detailed Description

This class is responsible for all the network related tasks.
It is a wrapper for OSCsharp and handles the event system for the Unity components.

15.7.2

Member Function Documentation

15.7.2.1

void UniOSC.UniOSCConnection.Awake ( )

15.7.2.2

void UniOSC.UniOSCConnection.ConnectOSC ( )

creates internally an UniOSCReciver which handles all the Network setup.
Called from GUI/Inspector

15.7.2.3

void UniOSC.UniOSCConnection.ConnectOSCOut ( )

Connects the OSC out.

15.7.2.4

void UniOSC.UniOSCConnection.DisconnectOSC ( )

Disconnects and destroys the OSCConnection.

15.7.2.5

void UniOSC.UniOSCConnection.DisconnectOSCOut ( )

Disconnects and release the OSC out connection.

15.7.2.6

static void UniOSC.UniOSCConnection.Init ( ) [static]

Init this instance.
Is called from Awake and OSCAutoRun
Generated for monoflow by Doxygen

51

52

15.7.2.7

Class Documentation

void UniOSC.UniOSCConnection.RenderGUI ( )

Renders the GUI of a OSCConnection in the GameView.
This is different from the rendering in the editor/inspector

15.7.2.8

void UniOSC.UniOSCConnection.SendOSCMessage ( object sender, UniOSCEventArgs args )

Sends the OSC message.
Parameters
sender
args

15.7.2.9

Sender.
UniOSCEventArgs

void UniOSC.UniOSCConnection.SendSessionData ( )

Sends the session data.
This is useful for updating the GUI of TouOSC for example with the last data values from incomming OSC messages.
You have to add a OSC Session file to the OSCConnection to use this feature.

15.7.2.10

void UniOSC.UniOSCConnection.SendTestMessage ( )

Sends the test message.
Only for testing the OSC Out connection.

15.7.2.11

IEnumerator UniOSC.UniOSCConnection.Start ( )

15.7.2.12

static void UniOSC.UniOSCConnection.Update_AvailablePorts ( ) [static]

Updates the available ports.
Should be called when a OSCConnection changes the Port.

15.7.3

Member Data Documentation

15.7.3.1

bool UniOSC.UniOSCConnection.autoConnectOSCIn = true

15.7.3.2

bool UniOSC.UniOSCConnection.autoConnectOSCOut = true

15.7.3.3

bool UniOSC.UniOSCConnection.dispatchOSC = true

15.7.3.4

bool UniOSC.UniOSCConnection.dispatchOSCOut = true

15.7.3.5

bool UniOSC.UniOSCConnection.foldoutOSCIn = true

15.7.3.6

bool UniOSC.UniOSCConnection.foldoutOSCOut = true

15.7.3.7

bool UniOSC.UniOSCConnection.isEditorEnabled = false [static]

15.7.3.8

bool UniOSC.UniOSCConnection.isOSCLearning = false [static]

15.7.3.9

string UniOSC.UniOSCConnection.localIPAddress = null [static]

Generated for monoflow by Doxygen

15.8 UniOSC.UniOSCConnectionEditor Class Reference

15.7.3.10

List UniOSC.UniOSCConnection.oscMappingFileObjList

15.7.3.11

bool UniOSC.UniOSCConnection.oscOut = true

15.7.3.12

string UniOSC.UniOSCConnection.oscOutIPAddress

15.7.3.13

int UniOSC.UniOSCConnection.oscOutPort = 9000

15.7.3.14

int UniOSC.UniOSCConnection.oscPort = 8000

15.7.3.15

List UniOSC.UniOSCConnection.oscSessionFileObjList

15.7.3.16

bool UniOSC.UniOSCConnection.redrawFlag

15.7.3.17

bool UniOSC.UniOSCConnection.SendSessionDataOnStart

15.7.4

Property Documentation

15.7.4.1

List UniOSC.UniOSCConnection.AvailableINPorts [static], [get]

15.7.4.2

List UniOSC.UniOSCConnection.AvailableOUTIPAddresses [static], [get]

15.7.4.3

List UniOSC.UniOSCConnection.AvailableOUTPorts [static], [get]

15.7.4.4

bool UniOSC.UniOSCConnection.hasOSCMappingFileAttached [get]

15.7.4.5

bool UniOSC.UniOSCConnection.hasOSCSessionFileAttached [get]

15.7.4.6

List UniOSC.UniOSCConnection.Instances [static], [get]

15.7.4.7

bool UniOSC.UniOSCConnection.isConnected [get]

15.7.4.8

bool UniOSC.UniOSCConnection.isConnectedOut [get]

15.7.5

Event Documentation

15.7.5.1

Action UniOSC.UniOSCConnection.ConnectionInStatusChange

15.7.5.2

Action UniOSC.UniOSCConnection.ConnectionOutStatusChange

15.7.5.3

EventHandler UniOSC.UniOSCConnection.OSCMessageReceived

15.7.5.4

EventHandler UniOSC.UniOSCConnection.OSCMessageReceivedRaw

15.7.5.5

EventHandler UniOSC.UniOSCConnection.OSCMessageSend

15.8

UniOSC.UniOSCConnectionEditor Class Reference

Inheritance diagram for UniOSC.UniOSCConnectionEditor:

Editor
UniOSC.UniOSCConnectionEditor

Generated for monoflow by Doxygen

53

54

Class Documentation

Public Member Functions
• override void OnInspectorGUI ()

Static Public Member Functions
• static void LoadTextures ()
• static void Show (string label, SerializedProperty list)
• static void ShowOSCReciverStatus (UniOSCConnection oscConnection)

Static Public Attributes
• static Texture2D texTestMessage
• static Texture2D texON
• static Texture2D texOFF

Protected Member Functions
• void ForceUpdate ()

15.8.1

Member Function Documentation

15.8.1.1

void UniOSC.UniOSCConnectionEditor.ForceUpdate ( ) [protected]

15.8.1.2

static void UniOSC.UniOSCConnectionEditor.LoadTextures ( ) [static]

15.8.1.3

override void UniOSC.UniOSCConnectionEditor.OnInspectorGUI ( )

15.8.1.4

static void UniOSC.UniOSCConnectionEditor.Show ( string label, SerializedProperty list ) [static]

15.8.1.5

static void UniOSC.UniOSCConnectionEditor.ShowOSCReciverStatus ( UniOSCConnection oscConnection )

[static]

15.8.2

Member Data Documentation

15.8.2.1

Texture2D UniOSC.UniOSCConnectionEditor.texOFF [static]

15.8.2.2

Texture2D UniOSC.UniOSCConnectionEditor.texON [static]

15.8.2.3

Texture2D UniOSC.UniOSCConnectionEditor.texTestMessage [static]

15.9

UniOSC.UniOSCEditor Class Reference

Editor for the administration of OSCconnections, mapping files.
Inheritance diagram for UniOSC.UniOSCEditor:

EditorWindow
UniOSC.UniOSCEditor

Generated for monoflow by Doxygen

15.9 UniOSC.UniOSCEditor Class Reference

55

Public Member Functions
• void OnEnable ()
• void OnDisable ()
• void OnHierarchyChange ()

Static Public Member Functions
• static void Init ()
Init this instance.

• static void OSCLearning (bool flag)
When entering the OSC learning mode the editor connects all mapping files to the event system so the OSC address
for a mapping item can be recorded.

Public Attributes
• const float TRACEWIDTH = 250f

Properties
• static bool isOSCLearning [get]
• static UniOSCEditor Instance [get, set]
• static bool IsOpen [get]

Events
• static EventHandler
< UniOSCEventArgs > OSCMessageReceived

15.9.1

Detailed Description

Editor for the administration of OSCconnections, mapping files.
You can also trace the OSC data flow .

15.9.2

Member Function Documentation

15.9.2.1

static void UniOSC.UniOSCEditor.Init ( ) [static]

Init this instance.
Called everytime the editor is opened or when we have to update the editor (After creating a OSCConnection,hit the
’Refresh’ button)

15.9.2.2

void UniOSC.UniOSCEditor.OnDisable ( )

15.9.2.3

void UniOSC.UniOSCEditor.OnEnable ( )

15.9.2.4

void UniOSC.UniOSCEditor.OnHierarchyChange ( )

15.9.2.5

static void UniOSC.UniOSCEditor.OSCLearning ( bool flag ) [static]

When entering the OSC learning mode the editor connects all mapping files to the event system so the OSC address
for a mapping item can be recorded.
Generated for monoflow by Doxygen

56

Class Documentation

Parameters
flag

If set to true flag.

15.9.3

Member Data Documentation

15.9.3.1

const float UniOSC.UniOSCEditor.TRACEWIDTH = 250f

15.9.4

Property Documentation

15.9.4.1 UniOSCEditor UniOSC.UniOSCEditor.Instance [static], [get], [set]
15.9.4.2

bool UniOSC.UniOSCEditor.IsOpen [static], [get]

15.9.4.3

bool UniOSC.UniOSCEditor.isOSCLearning [static], [get]

15.9.5

Event Documentation

15.9.5.1

EventHandler UniOSC.UniOSCEditor.OSCMessageReceived [static]

15.10

UniOSC.UniOSCEditorConfigObj Class Reference

UniOSC editor config object.
Inheritance diagram for UniOSC.UniOSCEditorConfigObj:

ScriptableObject
UniOSC.UniOSCEditorConfigObj

Public Member Functions
• void OnEnable ()

Public Attributes
• int selectedMappingFileObjIndex
• int selectedSessionFileObjIndex
• Vector2 configTraceScrollpos
• bool isOSCTracing
• bool isOSCLearning
• bool isEditorEnabled
• bool isLastMessageTracing
• GUISkin mySkin
• GUIStyle learnStyle
• List< UniOSCMappingFileObj > OSCMappingFileObjList
• List< UniOSCSessionFileObj > OSCSessionFileObjList
• int toolbarInt = 0
• Texture2D tex_LearnFrame
• Texture2D tex_logo
Generated for monoflow by Doxygen

15.11 UniOSC.UniOSCEventArgs Class Reference

15.10.1

Detailed Description

UniOSC editor config object.
Storage of all the UniOSCEditor settings

15.10.2

Member Function Documentation

15.10.2.1

void UniOSC.UniOSCEditorConfigObj.OnEnable ( )

15.10.3

Member Data Documentation

15.10.3.1

Vector2 UniOSC.UniOSCEditorConfigObj.configTraceScrollpos

15.10.3.2

bool UniOSC.UniOSCEditorConfigObj.isEditorEnabled

15.10.3.3

bool UniOSC.UniOSCEditorConfigObj.isLastMessageTracing

15.10.3.4

bool UniOSC.UniOSCEditorConfigObj.isOSCLearning

15.10.3.5

bool UniOSC.UniOSCEditorConfigObj.isOSCTracing

15.10.3.6

GUIStyle UniOSC.UniOSCEditorConfigObj.learnStyle

15.10.3.7

GUISkin UniOSC.UniOSCEditorConfigObj.mySkin

15.10.3.8

List UniOSC.UniOSCEditorConfigObj.OSCMappingFileObjList

15.10.3.9

List UniOSC.UniOSCEditorConfigObj.OSCSessionFileObjList

15.10.3.10

int UniOSC.UniOSCEditorConfigObj.selectedMappingFileObjIndex

15.10.3.11

int UniOSC.UniOSCEditorConfigObj.selectedSessionFileObjIndex

15.10.3.12

Texture2D UniOSC.UniOSCEditorConfigObj.tex_LearnFrame

15.10.3.13

Texture2D UniOSC.UniOSCEditorConfigObj.tex_logo

15.10.3.14

int UniOSC.UniOSCEditorConfigObj.toolbarInt = 0

15.11

UniOSC.UniOSCEventArgs Class Reference

A wrapper to a OscMessage class to also store the port and have a quick way to access the message address.
Inheritance diagram for UniOSC.UniOSCEventArgs:

EventArgs
UniOSC.UniOSCEventArgs

Public Member Functions
• UniOSCEventArgs (int port, OscMessage message)
Generated for monoflow by Doxygen

57

58

Class Documentation

Public Attributes
• string IPAddress

Properties
• OscMessage Message [get]
• string Address [get]
• int Port [get]
• int Group [get]
• string AddressRoot [get]
• int AddressIndex [get]

15.11.1

Detailed Description

A wrapper to a OscMessage class to also store the port and have a quick way to access the message address.
UniOSC use this class for the internal communication
this is a paragraph
See also
UniOSC.OSCEventTarget
UniOSC.OSCEventTarget

15.11.2

Constructor & Destructor Documentation

15.11.2.1

UniOSC.UniOSCEventArgs.UniOSCEventArgs ( int port, OscMessage message )

15.11.3

Member Data Documentation

15.11.3.1

string UniOSC.UniOSCEventArgs.IPAddress

15.11.4

Property Documentation

15.11.4.1

string UniOSC.UniOSCEventArgs.Address [get]

15.11.4.2

int UniOSC.UniOSCEventArgs.AddressIndex [get]

15.11.4.3

string UniOSC.UniOSCEventArgs.AddressRoot [get]

15.11.4.4

int UniOSC.UniOSCEventArgs.Group [get]

15.11.4.5

OscMessage UniOSC.UniOSCEventArgs.Message [get]

15.11.4.6

int UniOSC.UniOSCEventArgs.Port [get]

15.12

UniOSC.UniOSCEventDispatcher Class Reference

This is the abstract class you should subclass from when you want to sent OSC data
Inheritance diagram for UniOSC.UniOSCEventDispatcher:
Generated for monoflow by Doxygen

15.12 UniOSC.UniOSCEventDispatcher Class Reference

59

MonoBehaviour
UniOSC.UniOSCEventDispatcher
UniOSC.UniOSCEventDispatcherButton

UniOSC.UniOSCEventDispatcherImplementation

UniOSC.UniOSCTransformSender

Public Member Functions
•
•
•
•
•
•

virtual void Awake ()
virtual void Start ()
virtual void OnEnable ()
virtual void OnDestroy ()
virtual void OnDisable ()
void SendOSCMessage ()

•
•
•
•

void AppendData (object _data)
void ClearData ()
void StartSendIntervalTimer ()
void StopSendIntervalTimer ()

Sends the OSC message.

Public Attributes
•
•
•
•
•
•

string oscOutAddress ="/"
string oscOutIPAddress
int oscOutPort
float sendInterval =100
bool useExplicitConnection
UniOSCConnection explicitConnection

Protected Member Functions
•
•
•
•
•
•
•

void _OnTimedEvent (object source, System.Timers.ElapsedEventArgs e)
virtual void _Update ()
void _OnConnectionOutStatusChanged (UniOSCConnection con)
void _ConnectToOSCConnections ()
void _DisconnectFromOSCConnections ()
void _SetupOSCMessage ()
void _SendOSCMessage (UniOSCEventArgs args)

Protected Attributes
•
•
•
•
•
•

OscMessage _OSCmsg
UniOSCEventArgs _OSCeArg
System.Timers.Timer _sendIntervalTimer
bool _isOSCDirty
object _mylock = new object()
bool _drawDefaultInspector = true

15.12.1

Detailed Description

This is the abstract class you should subclass from when you want to sent OSC data
Generated for monoflow by Doxygen

60

Class Documentation

15.12.2

Member Function Documentation

15.12.2.1

void UniOSC.UniOSCEventDispatcher._ConnectToOSCConnections ( ) [protected]

15.12.2.2

void UniOSC.UniOSCEventDispatcher._DisconnectFromOSCConnections ( ) [protected]

15.12.2.3

void UniOSC.UniOSCEventDispatcher._OnConnectionOutStatusChanged ( UniOSCConnection con )

[protected]
15.12.2.4

void UniOSC.UniOSCEventDispatcher._OnTimedEvent ( object source, System.Timers.ElapsedEventArgs e )

[protected]
15.12.2.5

void UniOSC.UniOSCEventDispatcher._SendOSCMessage ( UniOSCEventArgs args ) [protected]

15.12.2.6

void UniOSC.UniOSCEventDispatcher._SetupOSCMessage ( ) [protected]

15.12.2.7

virtual void UniOSC.UniOSCEventDispatcher._Update ( ) [protected], [virtual]

Reimplemented in UniOSC.UniOSCTransformSender.

15.12.2.8

void UniOSC.UniOSCEventDispatcher.AppendData ( object _data )

15.12.2.9

virtual void UniOSC.UniOSCEventDispatcher.Awake ( ) [virtual]

Reimplemented in UniOSC.UniOSCEventDispatcherButton, and UniOSC.UniOSCEventDispatcherImplementation.

15.12.2.10

void UniOSC.UniOSCEventDispatcher.ClearData ( )

15.12.2.11

virtual void UniOSC.UniOSCEventDispatcher.OnDestroy ( ) [virtual]

15.12.2.12

virtual void UniOSC.UniOSCEventDispatcher.OnDisable ( ) [virtual]

Reimplemented in UniOSC.UniOSCEventDispatcherButton, UniOSC.UniOSCEventDispatcherImplementation, and
UniOSC.UniOSCTransformSender.

15.12.2.13

virtual void UniOSC.UniOSCEventDispatcher.OnEnable ( ) [virtual]

Reimplemented in UniOSC.UniOSCEventDispatcherButton, UniOSC.UniOSCEventDispatcherImplementation, and
UniOSC.UniOSCTransformSender.

15.12.2.14

void UniOSC.UniOSCEventDispatcher.SendOSCMessage ( )

Sends the OSC message.

15.12.2.15

virtual void UniOSC.UniOSCEventDispatcher.Start ( ) [virtual]

15.12.2.16

void UniOSC.UniOSCEventDispatcher.StartSendIntervalTimer ( )

15.12.2.17

void UniOSC.UniOSCEventDispatcher.StopSendIntervalTimer ( )

15.12.3

Member Data Documentation

15.12.3.1

bool UniOSC.UniOSCEventDispatcher._drawDefaultInspector = true [protected]

Generated for monoflow by Doxygen

15.13 UniOSC.UniOSCEventDispatcherButton Class Reference

15.12.3.2

bool UniOSC.UniOSCEventDispatcher._isOSCDirty [protected]

15.12.3.3

object UniOSC.UniOSCEventDispatcher._mylock = new object() [protected]

15.12.3.4 UniOSCEventArgs UniOSC.UniOSCEventDispatcher._OSCeArg [protected]
15.12.3.5

OscMessage UniOSC.UniOSCEventDispatcher._OSCmsg [protected]

15.12.3.6

System.Timers.Timer UniOSC.UniOSCEventDispatcher._sendIntervalTimer [protected]

15.12.3.7 UniOSCConnection UniOSC.UniOSCEventDispatcher.explicitConnection
15.12.3.8

string UniOSC.UniOSCEventDispatcher.oscOutAddress ="/"

15.12.3.9

string UniOSC.UniOSCEventDispatcher.oscOutIPAddress

15.12.3.10

int UniOSC.UniOSCEventDispatcher.oscOutPort

15.12.3.11

float UniOSC.UniOSCEventDispatcher.sendInterval =100

15.12.3.12

bool UniOSC.UniOSCEventDispatcher.useExplicitConnection

15.13

UniOSC.UniOSCEventDispatcherButton Class Reference

Dispatcher button that forces a OSCConnection to send a OSC Message.
Inheritance diagram for UniOSC.UniOSCEventDispatcherButton:

MonoBehaviour
UniOSC.UniOSCEventDispatcher
UniOSC.UniOSCEventDispatcherButton

Public Member Functions
•
•
•
•

override void Awake ()
override void OnEnable ()
override void OnDisable ()
void SendOSCMessageDown ()
Sends the OSC message with the downOSCDataValue.

• void SendOSCMessageUp ()
Sends the OSC message with the upOSCDataValue.

Public Attributes
•
•
•
•
•

float downOSCDataValue =1
float upOSCDataValue =0
bool showGUI
float xPos
float yPos

Generated for monoflow by Doxygen

61

62

Class Documentation

Additional Inherited Members
15.13.1

Detailed Description

Dispatcher button that forces a OSCConnection to send a OSC Message.
Two separate states: Down and Up

15.13.2

Member Function Documentation

15.13.2.1

override void UniOSC.UniOSCEventDispatcherButton.Awake ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventDispatcher.

15.13.2.2

override void UniOSC.UniOSCEventDispatcherButton.OnDisable ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventDispatcher.

15.13.2.3

override void UniOSC.UniOSCEventDispatcherButton.OnEnable ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventDispatcher.

15.13.2.4

void UniOSC.UniOSCEventDispatcherButton.SendOSCMessageDown ( )

Sends the OSC message with the downOSCDataValue.

15.13.2.5

void UniOSC.UniOSCEventDispatcherButton.SendOSCMessageUp ( )

Sends the OSC message with the upOSCDataValue.

15.13.3

Member Data Documentation

15.13.3.1

float UniOSC.UniOSCEventDispatcherButton.downOSCDataValue =1

15.13.3.2

bool UniOSC.UniOSCEventDispatcherButton.showGUI

15.13.3.3

float UniOSC.UniOSCEventDispatcherButton.upOSCDataValue =0

15.13.3.4

float UniOSC.UniOSCEventDispatcherButton.xPos

15.13.3.5

float UniOSC.UniOSCEventDispatcherButton.yPos

15.14

UniOSC.UniOSCEventDispatcherButtonEditor Class Reference

Uni OSC event dispatcher button editor.
Inheritance diagram for UniOSC.UniOSCEventDispatcherButtonEditor:
Generated for monoflow by Doxygen

15.15 UniOSC.UniOSCEventDispatcherCB Class Reference

Editor
UniOSC.UniOSCEventDispatcherEditor
UniOSC.UniOSCEventDispatcherButtonEditor

Public Member Functions
• override void OnEnable ()
• override void OnInspectorGUI ()

Protected Attributes
•
•
•
•
•

SerializedProperty downOSCDataValueProp
SerializedProperty upOSCDataValueProp
SerializedProperty ShowGUIProp
SerializedProperty xProp
SerializedProperty yProp

Additional Inherited Members
15.14.1

Detailed Description

Uni OSC event dispatcher button editor.

15.14.2

Member Function Documentation

15.14.2.1

override void UniOSC.UniOSCEventDispatcherButtonEditor.OnEnable ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventDispatcherEditor.

15.14.2.2

override void UniOSC.UniOSCEventDispatcherButtonEditor.OnInspectorGUI ( )

15.14.3

Member Data Documentation

15.14.3.1

SerializedProperty UniOSC.UniOSCEventDispatcherButtonEditor.downOSCDataValueProp [protected]

15.14.3.2

SerializedProperty UniOSC.UniOSCEventDispatcherButtonEditor.ShowGUIProp [protected]

15.14.3.3

SerializedProperty UniOSC.UniOSCEventDispatcherButtonEditor.upOSCDataValueProp [protected]

15.14.3.4

SerializedProperty UniOSC.UniOSCEventDispatcherButtonEditor.xProp [protected]

15.14.3.5

SerializedProperty UniOSC.UniOSCEventDispatcherButtonEditor.yProp [protected]

15.15

UniOSC.UniOSCEventDispatcherCB Class Reference

Inheritance diagram for UniOSC.UniOSCEventDispatcherCB:
Generated for monoflow by Doxygen

63

64

Class Documentation

IDisposable
UniOSC.UniOSCEventDispatcherCB
UniOSC.UniOSCEventDispatcherCBImplementation

Public Member Functions
•
•
•
•
•

void SetExplicitConnection (UniOSCConnection newCon)
UniOSCEventDispatcherCB (string _oscOutAddress, string _oscOutIPAddress, int _oscPort)
UniOSCEventDispatcherCB (string _oscOutAddress, UniOSCConnection _explicitConnection)
virtual void Awake ()
virtual void Enable ()
Enable this instance.

• virtual void Disable ()
Disable this instance.

• virtual void OnDestroy ()
• void SendOSCMessage ()
Sends the OSC message.

• void AppendData (object _data)
Append data.

• void ClearData ()
Clears all data.

• void StartSendIntervalTimer ()
Starts the send interval timer.

• void StopSendIntervalTimer ()
Stops the send interval timer.

• void Dispose ()
Performs application-defined tasks associated with freeing, releasing, or resetting resources.

Public Attributes
• float sendInterval =100

Protected Member Functions
•
•
•
•
•
•

void _OnTimedEvent (object source, System.Timers.ElapsedEventArgs e)
void _OnConnectionOutStatusChanged (UniOSCConnection con)
void _ConnectToOSCConnections ()
void _DisconnectFromOSCConnections ()
void _SetupOSCMessage ()
void _SendOSCMessage (UniOSCEventArgs args)

Protected Attributes
•
•
•
•
•

OscMessage _OSCmsg
UniOSCEventArgs _OSCeArg
System.Timers.Timer _sendIntervalTimer
bool _isOSCDirty
object _mylock = new object()
Generated for monoflow by Doxygen

15.15 UniOSC.UniOSCEventDispatcherCB Class Reference

65

Properties
•
•
•
•
•
•

bool isEnabled [get]
string oscOutAddress [get, set]
string oscOutIPAddress [get, set]
int oscOutPort [get, set]
bool useExplicitConnection [get, set]
UniOSCConnection explicitConnection [get, set]

15.15.1

Constructor & Destructor Documentation

15.15.1.1

UniOSC.UniOSCEventDispatcherCB.UniOSCEventDispatcherCB ( string _oscOutAddress, string _oscOutIPAddress,
int _oscPort )

15.15.1.2

UniOSC.UniOSCEventDispatcherCB.UniOSCEventDispatcherCB ( string _oscOutAddress, UniOSCConnection
_explicitConnection )

15.15.2

Member Function Documentation

15.15.2.1

void UniOSC.UniOSCEventDispatcherCB._ConnectToOSCConnections ( ) [protected]

15.15.2.2

void UniOSC.UniOSCEventDispatcherCB._DisconnectFromOSCConnections ( ) [protected]

15.15.2.3

void UniOSC.UniOSCEventDispatcherCB._OnConnectionOutStatusChanged ( UniOSCConnection con )

[protected]
15.15.2.4

void UniOSC.UniOSCEventDispatcherCB._OnTimedEvent ( object source, System.Timers.ElapsedEventArgs e )

[protected]
15.15.2.5

void UniOSC.UniOSCEventDispatcherCB._SendOSCMessage ( UniOSCEventArgs args ) [protected]

15.15.2.6

void UniOSC.UniOSCEventDispatcherCB._SetupOSCMessage ( ) [protected]

15.15.2.7

void UniOSC.UniOSCEventDispatcherCB.AppendData ( object _data )

Append data.
Parameters
_data

15.15.2.8

_data.

virtual void UniOSC.UniOSCEventDispatcherCB.Awake ( ) [virtual]

Reimplemented in UniOSC.UniOSCEventDispatcherCBImplementation.

15.15.2.9

void UniOSC.UniOSCEventDispatcherCB.ClearData ( )

Clears all data.

15.15.2.10

virtual void UniOSC.UniOSCEventDispatcherCB.Disable ( ) [virtual]

Disable this instance.
Reimplemented in UniOSC.UniOSCEventDispatcherCBImplementation.
Generated for monoflow by Doxygen

66

15.15.2.11

Class Documentation

void UniOSC.UniOSCEventDispatcherCB.Dispose ( )

Performs application-defined tasks associated with freeing, releasing, or resetting resources.
Call Dispose when you are finished using the UniOSC.UniOSCEventDispatcherCB. The Dispose method leaves the
UniOSC.UniOSCEventDispatcherCB in an unusable state. After calling Dispose, you must release all references to
the UniOSC.UniOSCEventDispatcherCB so the garbage collector can reclaim the memory that the UniOSC.Uni←OSCEventDispatcherCB was occupying.

15.15.2.12

virtual void UniOSC.UniOSCEventDispatcherCB.Enable ( ) [virtual]

Enable this instance.
Reimplemented in UniOSC.UniOSCEventDispatcherCBImplementation.

15.15.2.13

virtual void UniOSC.UniOSCEventDispatcherCB.OnDestroy ( ) [virtual]

15.15.2.14

void UniOSC.UniOSCEventDispatcherCB.SendOSCMessage ( )

Sends the OSC message.

15.15.2.15

void UniOSC.UniOSCEventDispatcherCB.SetExplicitConnection ( UniOSCConnection newCon )

15.15.2.16

void UniOSC.UniOSCEventDispatcherCB.StartSendIntervalTimer ( )

Starts the send interval timer.
This is useful when you need to send OSC data frequently. With the sendInterval property you specify the interval
in milliseconds

15.15.2.17

void UniOSC.UniOSCEventDispatcherCB.StopSendIntervalTimer ( )

Stops the send interval timer.

15.15.3

Member Data Documentation

15.15.3.1

bool UniOSC.UniOSCEventDispatcherCB._isOSCDirty [protected]

15.15.3.2

object UniOSC.UniOSCEventDispatcherCB._mylock = new object() [protected]

15.15.3.3 UniOSCEventArgs UniOSC.UniOSCEventDispatcherCB._OSCeArg [protected]
15.15.3.4

OscMessage UniOSC.UniOSCEventDispatcherCB._OSCmsg [protected]

15.15.3.5

System.Timers.Timer UniOSC.UniOSCEventDispatcherCB._sendIntervalTimer [protected]

15.15.3.6

float UniOSC.UniOSCEventDispatcherCB.sendInterval =100

15.15.4

Property Documentation

15.15.4.1 UniOSCConnection UniOSC.UniOSCEventDispatcherCB.explicitConnection [get], [set]
15.15.4.2

bool UniOSC.UniOSCEventDispatcherCB.isEnabled [get]

Generated for monoflow by Doxygen

15.16 UniOSC.UniOSCEventDispatcherCBImplementation Class Reference

67

15.15.4.3

string UniOSC.UniOSCEventDispatcherCB.oscOutAddress [get], [set]

15.15.4.4

string UniOSC.UniOSCEventDispatcherCB.oscOutIPAddress [get], [set]

15.15.4.5

int UniOSC.UniOSCEventDispatcherCB.oscOutPort [get], [set]

15.15.4.6

bool UniOSC.UniOSCEventDispatcherCB.useExplicitConnection [get], [set]

15.16

UniOSC.UniOSCEventDispatcherCBImplementation Class Reference

This class is a blueprint for your own implementations of the abstract class UniOSCEventDispatcherCodeBased
Dispatcher forces a OSCConnection to send a OSC Message.
Inheritance diagram for UniOSC.UniOSCEventDispatcherCBImplementation:

IDisposable
UniOSC.UniOSCEventDispatcherCB
UniOSC.UniOSCEventDispatcherCBImplementation

Public Member Functions
• UniOSCEventDispatcherCBImplementation (string _oscOutAddress, string _oscOutIPAddress, int _oscPort)
You have to override the constructors you want to use from the base class UniOSC.UniOSCEventDispatcherCode←Based class.

• UniOSCEventDispatcherCBImplementation
Connection)
• override void Awake ()
• override void Enable ()

(string

_oscOutAddress,

UniOSCConnection

_explicit←-

Enable this instance.

• override void Disable ()
Disable this instance.

• void SetDataAtIndex0 (bool val)
Just a demo method to show how you can change the data of your OSC Message

Additional Inherited Members
15.16.1

Detailed Description

This class is a blueprint for your own implementations of the abstract class UniOSCEventDispatcherCodeBased
Dispatcher forces a OSCConnection to send a OSC Message.
//Don’t forget the base callings !!!!

15.16.2

Constructor & Destructor Documentation

15.16.2.1

UniOSC.UniOSCEventDispatcherCBImplementation.UniOSCEventDispatcherCBImplementation ( string
_oscOutAddress, string _oscOutIPAddress, int _oscPort )

You have to override the constructors you want to use from the base class UniOSC.UniOSCEventDispatcherCode←Based class.
Generated for monoflow by Doxygen

68

Class Documentation

15.16.2.2

UniOSC.UniOSCEventDispatcherCBImplementation.UniOSCEventDispatcherCBImplementation ( string
_oscOutAddress, UniOSCConnection _explicitConnection )

15.16.3

Member Function Documentation

15.16.3.1

override void UniOSC.UniOSCEventDispatcherCBImplementation.Awake ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventDispatcherCB.

15.16.3.2

override void UniOSC.UniOSCEventDispatcherCBImplementation.Disable ( ) [virtual]

Disable this instance.
Reimplemented from UniOSC.UniOSCEventDispatcherCB.

15.16.3.3

override void UniOSC.UniOSCEventDispatcherCBImplementation.Enable ( ) [virtual]

Enable this instance.
Reimplemented from UniOSC.UniOSCEventDispatcherCB.

15.16.3.4

void UniOSC.UniOSCEventDispatcherCBImplementation.SetDataAtIndex0 ( bool val )

Just a demo method to show how you can change the data of your OSC Message
Parameters
val

15.17

If set to true value.

UniOSC.UniOSCEventDispatcherEditor Class Reference

Inheritance diagram for UniOSC.UniOSCEventDispatcherEditor:

Editor
UniOSC.UniOSCEventDispatcherEditor
UniOSC.UniOSCEventDispatcherButtonEditor

Public Member Functions
• virtual void OnEnable ()
• override void OnInspectorGUI ()

Static Public Member Functions
• static void Show (string label, SerializedProperty list)
Generated for monoflow by Doxygen

15.17 UniOSC.UniOSCEventDispatcherEditor Class Reference

Protected Member Functions
• void DrawPort ()
• void DrawIPAddress ()
• void DrawConnectionInfo ()

Protected Attributes
•
•
•
•
•
•
•
•
•
•
•
•
•

UniOSCEventDispatcher _target
SerializedProperty _myOSCConnectionsProp
SerializedProperty OSCConnectionsProp
SerializedProperty OSCOutPortProp
SerializedProperty OSCOutAddressProp
SerializedProperty OSCOutIPAddressProp
SerializedProperty OSCOutProp
SerializedProperty UseExplicitConnectionProp
SerializedProperty ExplicitConnectionProp
SerializedProperty drawDefaultInspectorProp
int _portIndex = 0
string[ ] _options
Texture2D _tex_logo

15.17.1

Member Function Documentation

15.17.1.1

void UniOSC.UniOSCEventDispatcherEditor.DrawConnectionInfo ( ) [protected]

15.17.1.2

void UniOSC.UniOSCEventDispatcherEditor.DrawIPAddress ( ) [protected]

15.17.1.3

void UniOSC.UniOSCEventDispatcherEditor.DrawPort ( ) [protected]

15.17.1.4

virtual void UniOSC.UniOSCEventDispatcherEditor.OnEnable ( ) [virtual]

Reimplemented in UniOSC.UniOSCEventDispatcherButtonEditor.

15.17.1.5

override void UniOSC.UniOSCEventDispatcherEditor.OnInspectorGUI ( )

15.17.1.6

static void UniOSC.UniOSCEventDispatcherEditor.Show ( string label, SerializedProperty list ) [static]

15.17.2

Member Data Documentation

15.17.2.1

SerializedProperty UniOSC.UniOSCEventDispatcherEditor._myOSCConnectionsProp [protected]

15.17.2.2

string [ ] UniOSC.UniOSCEventDispatcherEditor._options [protected]

15.17.2.3

int UniOSC.UniOSCEventDispatcherEditor._portIndex = 0 [protected]

15.17.2.4 UniOSCEventDispatcher UniOSC.UniOSCEventDispatcherEditor._target [protected]
15.17.2.5

Texture2D UniOSC.UniOSCEventDispatcherEditor._tex_logo [protected]

15.17.2.6

SerializedProperty UniOSC.UniOSCEventDispatcherEditor.drawDefaultInspectorProp [protected]

15.17.2.7

SerializedProperty UniOSC.UniOSCEventDispatcherEditor.ExplicitConnectionProp [protected]

Generated for monoflow by Doxygen

69

70

Class Documentation

15.17.2.8

SerializedProperty UniOSC.UniOSCEventDispatcherEditor.OSCConnectionsProp [protected]

15.17.2.9

SerializedProperty UniOSC.UniOSCEventDispatcherEditor.OSCOutAddressProp [protected]

15.17.2.10

SerializedProperty UniOSC.UniOSCEventDispatcherEditor.OSCOutIPAddressProp [protected]

15.17.2.11

SerializedProperty UniOSC.UniOSCEventDispatcherEditor.OSCOutPortProp [protected]

15.17.2.12

SerializedProperty UniOSC.UniOSCEventDispatcherEditor.OSCOutProp [protected]

15.17.2.13

SerializedProperty UniOSC.UniOSCEventDispatcherEditor.UseExplicitConnectionProp [protected]

15.18

UniOSC.UniOSCEventDispatcherImplementation Class Reference

This class is a blueprint for your own implementations of the abstract class UniOSCEventDispatcher Dispatcher
forces a OSCConnection to send a OSC Message.
Inheritance diagram for UniOSC.UniOSCEventDispatcherImplementation:

MonoBehaviour
UniOSC.UniOSCEventDispatcher
UniOSC.UniOSCEventDispatcherImplementation

Public Member Functions
• override void Awake ()
• override void OnEnable ()
• override void OnDisable ()
• void MySendOSCMessageTrigerMethod ()
Just a dummy method that shows how you trigger the OSC sending and how you could change the data of the OSC
Message

Public Attributes
• int dynamicIntValue = 1000
• float dynamicFloatValue = 1000f
• string dynamicStringValue = "Test"

Additional Inherited Members
15.18.1

Detailed Description

This class is a blueprint for your own implementations of the abstract class UniOSCEventDispatcher Dispatcher
forces a OSCConnection to send a OSC Message.
//Don’t forget the base callings !!!!
Generated for monoflow by Doxygen

15.19 UniOSC.UniOSCEventTarget Class Reference

71

15.18.2

Member Function Documentation

15.18.2.1

override void UniOSC.UniOSCEventDispatcherImplementation.Awake ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventDispatcher.

15.18.2.2

void UniOSC.UniOSCEventDispatcherImplementation.MySendOSCMessageTrigerMethod ( )

Just a dummy method that shows how you trigger the OSC sending and how you could change the data of the OSC
Message

15.18.2.3

override void UniOSC.UniOSCEventDispatcherImplementation.OnDisable ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventDispatcher.

15.18.2.4

override void UniOSC.UniOSCEventDispatcherImplementation.OnEnable ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventDispatcher.

15.18.3

Member Data Documentation

15.18.3.1

float UniOSC.UniOSCEventDispatcherImplementation.dynamicFloatValue = 1000f

15.18.3.2

int UniOSC.UniOSCEventDispatcherImplementation.dynamicIntValue = 1000

15.18.3.3

string UniOSC.UniOSCEventDispatcherImplementation.dynamicStringValue = "Test"

15.19

UniOSC.UniOSCEventTarget Class Reference

UniOSC event target.
Inheritance diagram for UniOSC.UniOSCEventTarget:
MonoBehaviour
UniOSC.UniOSCEventTarget
UniOSC.UniOSCChangeColor

UniOSC.UniOSCEventTargetImplementation

UniOSC.UniOSCMoveGameObject

UniOSC.UniOSCRotateGameObject

UniOSC.UniOSCRotateGameObjectTouchOSCGyro

UniOSC.UniOSCScaleGameObject

UniOSC.UniOSCToggle

Public Member Functions
• virtual void Start ()
• virtual void Update ()
• virtual void OnEnable ()
Enable this component and reinitialize.

• virtual void OnDestroy ()
• virtual void OnDisable ()
When the component is disabled we disconnect from all OSCConnections and clear some internal data.

• abstract void OnOSCMessageReceived (UniOSCEventArgs args)
You should override this method in a subclass to handle the OSC data.
Generated for monoflow by Doxygen

72

Class Documentation

Public Attributes
• Dictionary< UniOSCConnection,
List< UniOSCMappingItem > > ConnectToDict = new Dictionary>()
• string oscAddress
• bool receiveAllAddresses
• bool useExplicitConnection
• UniOSCConnection explicitConnection
• int oscPort
• bool receiveAllPorts

Protected Member Functions
• void _OnConnectionInStatusChanged (UniOSCConnection con)
• void _ConnectToDispatchers ()
• void _DisconnectFromDispatchers ()

Protected Attributes
• List< string > _oscAddresses = new List()
• bool _redrawFlag
• List< UnityEngine.Object > _foldoutList = new List()

Properties
• List< string > GetOSCAddresses [get]

Events
• EventHandler< UniOSCEventArgs > OSCMessageReceived
Occurs when the OnOSCMessageReceived method iscalled.

15.19.1

Detailed Description

UniOSC event target.
This is the abstract class you should subclass from when you want to receive OSC data

15.19.2

Member Function Documentation

15.19.2.1

void UniOSC.UniOSCEventTarget._ConnectToDispatchers ( ) [protected]

15.19.2.2

void UniOSC.UniOSCEventTarget._DisconnectFromDispatchers ( ) [protected]

15.19.2.3

void UniOSC.UniOSCEventTarget._OnConnectionInStatusChanged ( UniOSCConnection con )

[protected]
15.19.2.4

virtual void UniOSC.UniOSCEventTarget.OnDestroy ( ) [virtual]

15.19.2.5

virtual void UniOSC.UniOSCEventTarget.OnDisable ( ) [virtual]

When the component is disabled we disconnect from all OSCConnections and clear some internal data.
Generated for monoflow by Doxygen

15.19 UniOSC.UniOSCEventTarget Class Reference

73

Reimplemented in UniOSC.UniOSCEventTargetImplementation.

15.19.2.6

virtual void UniOSC.UniOSCEventTarget.OnEnable ( ) [virtual]

Enable this component and reinitialize.
If a property of the component is changed via the inspector we force a OnEnable to update the status of the
component. In general the component disconnects from all OSCConnections and try to find a new OSCConnection
to connect to with a matching port. If you change properties via code you should call this explicit.
Reimplemented in UniOSC.UniOSCToggle, UniOSC.UniOSCChangeColor, UniOSC.UniOSCRotateGameObject,
UniOSC.UniOSCEventTargetImplementation, UniOSC.UniOSCScaleGameObject, UniOSC.UniOSCRotateGame←ObjectTouchOSCGyro, and UniOSC.UniOSCMoveGameObject.

15.19.2.7

abstract void UniOSC.UniOSCEventTarget.OnOSCMessageReceived ( UniOSCEventArgs args ) [pure

virtual]
You should override this method in a subclass to handle the OSC data.
Parameters
args

The current OSCEventArgs object

Implemented in UniOSC.UniOSCEventTargetImplementation, UniOSC.UniOSCToggle, UniOSC.UniOSCRotate←GameObject, UniOSC.UniOSCChangeColor, UniOSC.UniOSCRotateGameObjectTouchOSCGyro, UniOSC.Uni←OSCMoveGameObject, and UniOSC.UniOSCScaleGameObject.

15.19.2.8

virtual void UniOSC.UniOSCEventTarget.Start ( ) [virtual]

Reimplemented in UniOSC.UniOSCEventTargetImplementation.

15.19.2.9

virtual void UniOSC.UniOSCEventTarget.Update ( ) [virtual]

Reimplemented in UniOSC.UniOSCEventTargetImplementation.

15.19.3

Member Data Documentation

15.19.3.1

List UniOSC.UniOSCEventTarget._foldoutList = new List()
[protected]

15.19.3.2

List UniOSC.UniOSCEventTarget._oscAddresses = new List() [protected]

15.19.3.3

bool UniOSC.UniOSCEventTarget._redrawFlag [protected]

15.19.3.4

Dictionary > UniOSC.UniOSCEventTarget.ConnectToDict
= new Dictionary>()

15.19.3.5 UniOSCConnection UniOSC.UniOSCEventTarget.explicitConnection
15.19.3.6

string UniOSC.UniOSCEventTarget.oscAddress

15.19.3.7

int UniOSC.UniOSCEventTarget.oscPort

15.19.3.8

bool UniOSC.UniOSCEventTarget.receiveAllAddresses

Generated for monoflow by Doxygen

74

Class Documentation

15.19.3.9
15.19.3.10

bool UniOSC.UniOSCEventTarget.receiveAllPorts
bool UniOSC.UniOSCEventTarget.useExplicitConnection

15.19.4

Property Documentation

15.19.4.1

List UniOSC.UniOSCEventTarget.GetOSCAddresses [get]

15.19.5

Event Documentation

15.19.5.1

EventHandler UniOSC.UniOSCEventTarget.OSCMessageReceived

Occurs when the OnOSCMessageReceived method iscalled.

15.20

UniOSC.UniOSCEventTargetCB Class Reference

UniOSC event target for class based scripting.
Inheritance diagram for UniOSC.UniOSCEventTargetCB:

IDisposable
UniOSC.UniOSCEventTargetCB
UniOSC.UniOSCEventTargetCBImplementation

Public Member Functions
•
•
•
•
•
•
•
•

void SetExplicitConnection (UniOSCConnection newCon)
UniOSCEventTargetCB (int _oscPort)
UniOSCEventTargetCB (string _oscAddress)
UniOSCEventTargetCB (string _oscAddress, int _oscPort)
UniOSCEventTargetCB (UniOSCConnection con)
UniOSCEventTargetCB (string _oscAddress, UniOSCConnection con)
virtual void Awake ()
virtual void Enable ()
Enable this instance.

• virtual void Disable ()
Disable this instance.

• void Dispose ()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

• abstract void OnOSCMessageReceived (UniOSCEventArgs args)
You should override this method in a subclass to handle the OSC data.

Public Attributes
• Dictionary< UniOSCConnection,
List< UniOSCMappingItem > > ConnectToDict = new Dictionary>()
Generated for monoflow by Doxygen

15.20 UniOSC.UniOSCEventTargetCB Class Reference

75

Protected Attributes
• List< string > _oscAddresses = new List()

Properties
•
•
•
•
•
•
•

bool isEnabled [get]
string oscAddress [get, set]
bool receiveAllAddresses [get, set]
bool useExplicitConnection [get, set]
UniOSCConnection explicitConnection [get, set]
int oscPort [get, set]
bool receiveAllPorts [get, set]

Events
• EventHandler< UniOSCEventArgs > OSCMessageReceived

15.20.1

Detailed Description

UniOSC event target for class based scripting.
This is the abstract class you should subclass from

15.20.2

Constructor & Destructor Documentation

15.20.2.1

UniOSC.UniOSCEventTargetCB.UniOSCEventTargetCB ( int _oscPort )

15.20.2.2

UniOSC.UniOSCEventTargetCB.UniOSCEventTargetCB ( string _oscAddress )

15.20.2.3

UniOSC.UniOSCEventTargetCB.UniOSCEventTargetCB ( string _oscAddress, int _oscPort )

15.20.2.4

UniOSC.UniOSCEventTargetCB.UniOSCEventTargetCB ( UniOSCConnection con )

15.20.2.5

UniOSC.UniOSCEventTargetCB.UniOSCEventTargetCB ( string _oscAddress, UniOSCConnection con )

15.20.3

Member Function Documentation

15.20.3.1

virtual void UniOSC.UniOSCEventTargetCB.Awake ( ) [virtual]

Reimplemented in UniOSC.UniOSCEventTargetCBImplementation.

15.20.3.2

virtual void UniOSC.UniOSCEventTargetCB.Disable ( ) [virtual]

Disable this instance.
Reimplemented in UniOSC.UniOSCEventTargetCBImplementation.

15.20.3.3

void UniOSC.UniOSCEventTargetCB.Dispose ( )

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Call Dispose when you are finished using the UniOSC.UniOSCEventTargetCB. The Dispose method leaves the
UniOSC.UniOSCEventTargetCB in an unusable state. After calling Dispose, you must release all references to the
Generated for monoflow by Doxygen

76

Class Documentation

UniOSC.UniOSCEventTargetCB so the garbage collector can reclaim the memory that the UniOSC.UniOSCEvent←TargetCB was occupying.

15.20.3.4

virtual void UniOSC.UniOSCEventTargetCB.Enable ( ) [virtual]

Enable this instance.
Reimplemented in UniOSC.UniOSCEventTargetCBImplementation.

15.20.3.5

abstract void UniOSC.UniOSCEventTargetCB.OnOSCMessageReceived ( UniOSCEventArgs args ) [pure

virtual]
You should override this method in a subclass to handle the OSC data.
Parameters
args

The current OSCEventArgs object

Implemented in UniOSC.UniOSCEventTargetCBImplementation.

15.20.3.6

void UniOSC.UniOSCEventTargetCB.SetExplicitConnection ( UniOSCConnection newCon )

15.20.4

Member Data Documentation

15.20.4.1

List UniOSC.UniOSCEventTargetCB._oscAddresses = new List() [protected]

15.20.4.2

Dictionary > UniOSC.UniOSCEventTargetCB.Connect←ToDict = new Dictionary>()

15.20.5

Property Documentation

15.20.5.1 UniOSCConnection UniOSC.UniOSCEventTargetCB.explicitConnection [get], [set]
15.20.5.2

bool UniOSC.UniOSCEventTargetCB.isEnabled [get]

15.20.5.3

string UniOSC.UniOSCEventTargetCB.oscAddress [get], [set]

15.20.5.4

int UniOSC.UniOSCEventTargetCB.oscPort [get], [set]

15.20.5.5

bool UniOSC.UniOSCEventTargetCB.receiveAllAddresses [get], [set]

15.20.5.6

bool UniOSC.UniOSCEventTargetCB.receiveAllPorts [get], [set]

15.20.5.7

bool UniOSC.UniOSCEventTargetCB.useExplicitConnection [get], [set]

15.20.6

Event Documentation

15.20.6.1

EventHandler UniOSC.UniOSCEventTargetCB.OSCMessageReceived

15.21

UniOSC.UniOSCEventTargetCBImplementation Class Reference

This class is a blueprint for your own implementations of the abstract class OSCDispatcherTargetCB //Don’t forget
the base callings !!!! The OnOSCMessageReceived method is where you should parse the OSC data
Inheritance diagram for UniOSC.UniOSCEventTargetCBImplementation:
Generated for monoflow by Doxygen

15.21 UniOSC.UniOSCEventTargetCBImplementation Class Reference

77

IDisposable
UniOSC.UniOSCEventTargetCB
UniOSC.UniOSCEventTargetCBImplementation

Public Member Functions
• UniOSCEventTargetCBImplementation (int oscPort)
You have to override the constructors you want to use from the base class UniOSC.UniOSCEventTargetCB class.

•
•
•
•
•
•

UniOSCEventTargetCBImplementation (string oscAddress)
UniOSCEventTargetCBImplementation (UniOSCConnection con)
UniOSCEventTargetCBImplementation (string oscAddress, int oscPort)
UniOSCEventTargetCBImplementation (string oscAddress, UniOSCConnection con)
override void Awake ()
override void Enable ()
Enable this instance.

• override void Disable ()
Disable this instance.

• override void OnOSCMessageReceived (UniOSCEventArgs args)
Method is called from a OSCConnection when a OSC message arrives.

Additional Inherited Members
15.21.1

Detailed Description

This class is a blueprint for your own implementations of the abstract class OSCDispatcherTargetCB //Don’t forget
the base callings !!!! The OnOSCMessageReceived method is where you should parse the OSC data

15.21.2

Constructor & Destructor Documentation

15.21.2.1

UniOSC.UniOSCEventTargetCBImplementation.UniOSCEventTargetCBImplementation ( int oscPort )

You have to override the constructors you want to use from the base class UniOSC.UniOSCEventTargetCB class.

15.21.2.2

UniOSC.UniOSCEventTargetCBImplementation.UniOSCEventTargetCBImplementation ( string oscAddress )

15.21.2.3

UniOSC.UniOSCEventTargetCBImplementation.UniOSCEventTargetCBImplementation ( UniOSCConnection con )

15.21.2.4

UniOSC.UniOSCEventTargetCBImplementation.UniOSCEventTargetCBImplementation ( string oscAddress, int
oscPort )

15.21.2.5

UniOSC.UniOSCEventTargetCBImplementation.UniOSCEventTargetCBImplementation ( string oscAddress,
UniOSCConnection con )

15.21.3

Member Function Documentation

15.21.3.1

override void UniOSC.UniOSCEventTargetCBImplementation.Awake ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventTargetCB.
Generated for monoflow by Doxygen

78

Class Documentation

15.21.3.2

override void UniOSC.UniOSCEventTargetCBImplementation.Disable ( ) [virtual]

Disable this instance.
Reimplemented from UniOSC.UniOSCEventTargetCB.

15.21.3.3

override void UniOSC.UniOSCEventTargetCBImplementation.Enable ( ) [virtual]

Enable this instance.
Reimplemented from UniOSC.UniOSCEventTargetCB.

15.21.3.4

override void UniOSC.UniOSCEventTargetCBImplementation.OnOSCMessageReceived ( UniOSCEventArgs args
) [virtual]

Method is called from a OSCConnection when a OSC message arrives.
The argument is a UniOSCEventArgs object where all the related data is enclosed
Parameters
args

OSCEventArgs

Implements UniOSC.UniOSCEventTargetCB.

15.22

UniOSC.UniOSCEventTargetEditor Class Reference

Inheritance diagram for UniOSC.UniOSCEventTargetEditor:
Editor
UniOSC.UniOSCEventTargetEditor
UniOSC.UniOSCChangeColorEditor

UniOSC.UniOSCRotateGameObjectEditor

UniOSC.UniOSCToggleEditor

Public Member Functions
• virtual void OnEnable ()
• override void OnInspectorGUI ()

Protected Member Functions
•
•
•
•

void DrawConnectionSetup ()
void DrawPort ()
void DrawConnectionInfo ()
void ShowFoldoutConnectionStatus (string label, SerializedProperty list, IDictionary dict)

Protected Attributes
•
•
•
•

UniOSCEventTarget _target
SerializedProperty ReceiveAllAddressesProp
SerializedProperty ReceiveAllPortsProp
SerializedProperty OSCAddressProp
Generated for monoflow by Doxygen

15.22 UniOSC.UniOSCEventTargetEditor Class Reference

• SerializedProperty OSCPortProp
• SerializedProperty FoldoutListProp
• SerializedProperty AvailableINPortsProp
• SerializedProperty UseExplicitConnectionProp
• SerializedProperty ExplicitConnectionProp
• Texture2D _tex_logo
• int _portIndex = 0
• string[ ] _options

15.22.1

Member Function Documentation

15.22.1.1

void UniOSC.UniOSCEventTargetEditor.DrawConnectionInfo ( ) [protected]

15.22.1.2

void UniOSC.UniOSCEventTargetEditor.DrawConnectionSetup ( ) [protected]

15.22.1.3

void UniOSC.UniOSCEventTargetEditor.DrawPort ( ) [protected]

15.22.1.4

virtual void UniOSC.UniOSCEventTargetEditor.OnEnable ( ) [virtual]

Reimplemented in UniOSC.UniOSCToggleEditor.

15.22.1.5

override void UniOSC.UniOSCEventTargetEditor.OnInspectorGUI ( )

15.22.1.6

void UniOSC.UniOSCEventTargetEditor.ShowFoldoutConnectionStatus ( string label, SerializedProperty list,
IDictionary dict ) [protected]

15.22.2

Member Data Documentation

15.22.2.1

string [ ] UniOSC.UniOSCEventTargetEditor._options [protected]

15.22.2.2

int UniOSC.UniOSCEventTargetEditor._portIndex = 0 [protected]

15.22.2.3 UniOSCEventTarget UniOSC.UniOSCEventTargetEditor._target [protected]
15.22.2.4

Texture2D UniOSC.UniOSCEventTargetEditor._tex_logo [protected]

15.22.2.5

SerializedProperty UniOSC.UniOSCEventTargetEditor.AvailableINPortsProp [protected]

15.22.2.6

SerializedProperty UniOSC.UniOSCEventTargetEditor.ExplicitConnectionProp [protected]

15.22.2.7

SerializedProperty UniOSC.UniOSCEventTargetEditor.FoldoutListProp [protected]

15.22.2.8

SerializedProperty UniOSC.UniOSCEventTargetEditor.OSCAddressProp [protected]

15.22.2.9

SerializedProperty UniOSC.UniOSCEventTargetEditor.OSCPortProp [protected]

15.22.2.10

SerializedProperty UniOSC.UniOSCEventTargetEditor.ReceiveAllAddressesProp [protected]

15.22.2.11

SerializedProperty UniOSC.UniOSCEventTargetEditor.ReceiveAllPortsProp [protected]

15.22.2.12

SerializedProperty UniOSC.UniOSCEventTargetEditor.UseExplicitConnectionProp [protected]

Generated for monoflow by Doxygen

79

80

Class Documentation

15.23

UniOSC.UniOSCEventTargetImplementation Class Reference

This class is a blueprint for your own implementations of the abstract class OSCDispatcherTarget //Don’t forget the
base callings !!!! The OnOSCMessageReceived method is where you should parse the OSC data
Inheritance diagram for UniOSC.UniOSCEventTargetImplementation:

MonoBehaviour
UniOSC.UniOSCEventTarget
UniOSC.UniOSCEventTargetImplementation

Public Member Functions
• override void Start ()
Start this instance.

• override void OnEnable ()
Raises the enable event.

• override void OnDisable ()
Raises the disable event.

• override void Update ()
• override void OnOSCMessageReceived (UniOSCEventArgs args)
Method is called from a OSCConnection when a OSC message arrives.

Additional Inherited Members
15.23.1

Detailed Description

This class is a blueprint for your own implementations of the abstract class OSCDispatcherTarget //Don’t forget the
base callings !!!! The OnOSCMessageReceived method is where you should parse the OSC data

15.23.2

Member Function Documentation

15.23.2.1

override void UniOSC.UniOSCEventTargetImplementation.OnDisable ( ) [virtual]

Raises the disable event.
Reimplemented from UniOSC.UniOSCEventTarget.

15.23.2.2

override void UniOSC.UniOSCEventTargetImplementation.OnEnable ( ) [virtual]

Raises the enable event.
If you want to listen to several OSC messages you have to set the OSCAddresses property before you call base.←OnEnable() OSCAddresses.Clear(); OSCAddresses.Add(...);
Reimplemented from UniOSC.UniOSCEventTarget.
Generated for monoflow by Doxygen

15.24 UniOSC.UniOSCFileObj Class Reference

15.23.2.3

81

override void UniOSC.UniOSCEventTargetImplementation.OnOSCMessageReceived ( UniOSCEventArgs args )

[virtual]
Method is called from a OSCConnection when a OSC message arrives.
The argument is a UniOSCEventArgs object where all the related data is enclosed
Parameters
args

OSCEventArgs

Implements UniOSC.UniOSCEventTarget.

15.23.2.4

override void UniOSC.UniOSCEventTargetImplementation.Start ( ) [virtual]

Start this instance.
Reimplemented from UniOSC.UniOSCEventTarget.

15.23.2.5

override void UniOSC.UniOSCEventTargetImplementation.Update ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventTarget.

15.24

UniOSC.UniOSCFileObj Class Reference

Inheritance diagram for UniOSC.UniOSCFileObj:

ScriptableObject
UniOSC.UniOSCFileObj
UniOSC.UniOSCMappingFileObj

UniOSC.UniOSCSessionFileObj

Public Attributes
• string my_guid
• bool IsLearning
• Vector2 scrollpos = new Vector2()
• Vector2 scrollposInspector = new Vector2()

Events
• EventHandler< UniOSCEventArgs > OSCMessageSend

15.24.1

Detailed Description

15.24.2

Member Data Documentation

15.24.2.1

bool UniOSC.UniOSCFileObj.IsLearning

Generated for monoflow by Doxygen

82

Class Documentation

15.24.2.2

string UniOSC.UniOSCFileObj.my_guid

15.24.2.3

Vector2 UniOSC.UniOSCFileObj.scrollpos = new Vector2()

15.24.2.4

Vector2 UniOSC.UniOSCFileObj.scrollposInspector = new Vector2()

15.24.3

Event Documentation

15.24.3.1

EventHandler UniOSC.UniOSCFileObj.OSCMessageSend

15.25

UniOSC.UniOSCGUI Class Reference

GUI class that mimics the UniOSC editor interface for runtime use You can start/stop the OSCConnections and
trace OSC data messages
Inheritance diagram for UniOSC.UniOSCGUI:

MonoBehaviour
UniOSC.UniOSCGUI

Public Attributes
• bool ShowInEditMode
• bool traceMessages

15.25.1

Detailed Description

GUI class that mimics the UniOSC editor interface for runtime use You can start/stop the OSCConnections and
trace OSC data messages

15.25.2

Member Data Documentation

15.25.2.1

bool UniOSC.UniOSCGUI.ShowInEditMode

15.25.2.2

bool UniOSC.UniOSCGUI.traceMessages

15.26

UniOSC.UniOSCMappingFileObj Class Reference

Mapping file class .
Inheritance diagram for UniOSC.UniOSCMappingFileObj:

ScriptableObject
UniOSC.UniOSCFileObj
UniOSC.UniOSCMappingFileObj

Generated for monoflow by Doxygen

15.26 UniOSC.UniOSCMappingFileObj Class Reference

83

Public Member Functions
• void OnEnable ()
• void AddOSCMappingItem ()
Adds a new OSC Mapping item.

• void RemoveOSCMappingItem (UniOSCMappingItem obj)
Removes the OSC Mapping item from the list and destroys the item instance.

• void OnOSCMessageReceived (object sender, UniOSCEventArgs args)
Checks if we are in learning mode an writes the OSC message address into the address property of a mapping item
that is in learn mode(when user hold down the ’learn’ button in the editor.

Public Attributes
• List< UniOSCMappingItem > oscMappingItemList

Additional Inherited Members
15.26.1

Detailed Description

Mapping file class .
Every mapping file get stored as a .asset file. You can copy & paste a mapping file to another Unity project but you
have to aware that sometimes Unity changes the serialization format. If you have any trouble go to ’Edit/Project
Settings/Editor’ and change the seriaization mode to ’Force Text’ and then switch back to ’Force Binary’

15.26.2

Member Function Documentation

15.26.2.1

void UniOSC.UniOSCMappingFileObj.AddOSCMappingItem ( )

Adds a new OSC Mapping item.

15.26.2.2

void UniOSC.UniOSCMappingFileObj.OnEnable ( )

15.26.2.3

void UniOSC.UniOSCMappingFileObj.OnOSCMessageReceived ( object sender, UniOSCEventArgs args )

Checks if we are in learning mode an writes the OSC message address into the address property of a mapping
item that is in learn mode(when user hold down the ’learn’ button in the editor.
Parameters
sender
args

15.26.2.4

Sender.
UniOSCEventArgs that contains the OSC message

void UniOSC.UniOSCMappingFileObj.RemoveOSCMappingItem ( UniOSCMappingItem obj )

Removes the OSC Mapping item from the list and destroys the item instance.
UniOSC.UniOSCMappingItem.OnOSCDataDispatcherDelete
Parameters

Generated for monoflow by Doxygen

84

Class Documentation

obj

Object to remove.

15.26.3

Member Data Documentation

15.26.3.1

List UniOSC.UniOSCMappingFileObj.oscMappingItemList

15.27

UniOSC.UniOSCMappingFileObjEditor Class Reference

Inheritance diagram for UniOSC.UniOSCMappingFileObjEditor:

Editor
UniOSC.UniOSCMappingFileObjEditor

Public Member Functions
• override void OnInspectorGUI ()

Static Public Member Functions
• static void Init ()
• static void OnGUI_OSCMappingData_Editor (UniOSCMappingFileObj obj, float screenWidth, float screen←Height)
• static void OnGUI_OSCMappingData_Inspector (UniOSCMappingFileObj obj, float screenWidth, float
screenHeight)

Static Public Attributes
• static GUIStyle style

15.27.1

Member Function Documentation

15.27.1.1

static void UniOSC.UniOSCMappingFileObjEditor.Init ( ) [static]

15.27.1.2

static void UniOSC.UniOSCMappingFileObjEditor.OnGUI_OSCMappingData_Editor ( UniOSCMappingFileObj obj,
float screenWidth, float screenHeight ) [static]

15.27.1.3

static void UniOSC.UniOSCMappingFileObjEditor.OnGUI_OSCMappingData_Inspector ( UniOSCMappingFileObj
obj, float screenWidth, float screenHeight ) [static]

15.27.1.4

override void UniOSC.UniOSCMappingFileObjEditor.OnInspectorGUI ( )

15.27.2

Member Data Documentation

15.27.2.1

GUIStyle UniOSC.UniOSCMappingFileObjEditor.style [static]

15.28

UniOSC.UniOSCMappingItem Class Reference

Uni OSC mapping item.
Generated for monoflow by Doxygen

15.28 UniOSC.UniOSCMappingItem Class Reference

Public Member Functions
• UniOSCMappingItem ()
• UniOSCMappingItem (UniOSCMappingFileObj _hostObj)
Initializes a new instance of the UniOSC.UniOSCMappingItem class.

• void OnOSCMappingItemDelete ()
Removes this item from the UniOSCMappingFileObj host object.Afterwards it gets destroyed.

• void MapData (UniOSCEventArgs args)
Maps the incoming OSC data.

Public Attributes
•
•
•
•
•
•
•
•
•
•

UniOSCMappingFileObj hostObj
string address = ""
float min =0f
float max =1f
float mappingMIN =0f
float mappingMAX =1f
bool isLearning
const int MAXWIDTH = 250
const int MAXHEIGTH = 150
bool collapsed = true

15.28.1

Detailed Description

Uni OSC mapping item.

 Stefan Schlupek 

15.28.2

Constructor & Destructor Documentation

15.28.2.1

UniOSC.UniOSCMappingItem.UniOSCMappingItem ( )

15.28.2.2

UniOSC.UniOSCMappingItem.UniOSCMappingItem ( UniOSCMappingFileObj _hostObj )

Initializes a new instance of the UniOSC.UniOSCMappingItem class.
Parameters
_hostObj

The UniOSCMappingFileObj object that host the item

15.28.3

Member Function Documentation

15.28.3.1

void UniOSC.UniOSCMappingItem.MapData ( UniOSCEventArgs args )

Maps the incoming OSC data.
Parameters
args

15.28.3.2

Arguments.

void UniOSC.UniOSCMappingItem.OnOSCMappingItemDelete ( )

Removes this item from the UniOSCMappingFileObj host object.Afterwards it gets destroyed.
Generated for monoflow by Doxygen

85

86

Class Documentation

15.28.4

Member Data Documentation

15.28.4.1

string UniOSC.UniOSCMappingItem.address = ""

15.28.4.2

bool UniOSC.UniOSCMappingItem.collapsed = true

15.28.4.3 UniOSCMappingFileObj UniOSC.UniOSCMappingItem.hostObj
15.28.4.4

bool UniOSC.UniOSCMappingItem.isLearning

15.28.4.5

float UniOSC.UniOSCMappingItem.mappingMAX =1f

15.28.4.6

float UniOSC.UniOSCMappingItem.mappingMIN =0f

15.28.4.7

float UniOSC.UniOSCMappingItem.max =1f

15.28.4.8

const int UniOSC.UniOSCMappingItem.MAXHEIGTH = 150

15.28.4.9

const int UniOSC.UniOSCMappingItem.MAXWIDTH = 250

15.28.4.10

15.29

float UniOSC.UniOSCMappingItem.min =0f

UniOSC.UniOSCMappingItemEditor Class Reference

Inheritance diagram for UniOSC.UniOSCMappingItemEditor:

Editor
UniOSC.UniOSCMappingItemEditor

Public Member Functions
• void OnEnable ()

Static Public Member Functions
• static void OnGUI_Editor (UniOSCMappingItem obj)
• static void OnGUI_Inspector (UniOSCMappingItem obj)

15.29.1

Member Function Documentation

15.29.1.1

void UniOSC.UniOSCMappingItemEditor.OnEnable ( )

15.29.1.2

static void UniOSC.UniOSCMappingItemEditor.OnGUI_Editor ( UniOSCMappingItem obj ) [static]

15.29.1.3

static void UniOSC.UniOSCMappingItemEditor.OnGUI_Inspector ( UniOSCMappingItem obj ) [static]

15.30

UniOSC.UniOSCMoveGameObject Class Reference

Moves a GameObject in normalized coordinates (ScreenToWorldPoint)
Generated for monoflow by Doxygen

15.30 UniOSC.UniOSCMoveGameObject Class Reference

87

Inheritance diagram for UniOSC.UniOSCMoveGameObject:

MonoBehaviour
UniOSC.UniOSCEventTarget
UniOSC.UniOSCMoveGameObject

Public Types
• enum Mode { Mode.Screen, Mode.Relative }

Public Member Functions
• override void OnEnable ()
Enable this component and reinitialize.

• override void OnOSCMessageReceived (UniOSCEventArgs args)
You should override this method in a subclass to handle the OSC data.

Public Attributes
• Transform transformToMove
• float nearClipPlaneOffset = 1
• Mode movementMode

Additional Inherited Members
15.30.1

Detailed Description

Moves a GameObject in normalized coordinates (ScreenToWorldPoint)

15.30.2

Member Enumeration Documentation

15.30.2.1

enum UniOSC.UniOSCMoveGameObject.Mode

Enumerator
Screen
Relative

15.30.3

Member Function Documentation

15.30.3.1

override void UniOSC.UniOSCMoveGameObject.OnEnable ( ) [virtual]

Enable this component and reinitialize.
If a property of the component is changed via the inspector we force a OnEnable to update the status of the
component. In general the component disconnects from all OSCConnections and try to find a new OSCConnection
to connect to with a matching port. If you change properties via code you should call this explicit.
Reimplemented from UniOSC.UniOSCEventTarget.
Generated for monoflow by Doxygen

88

Class Documentation

15.30.3.2

override void UniOSC.UniOSCMoveGameObject.OnOSCMessageReceived ( UniOSCEventArgs args )

[virtual]
You should override this method in a subclass to handle the OSC data.
Parameters
args

The current OSCEventArgs object

Implements UniOSC.UniOSCEventTarget.

15.30.4

Member Data Documentation

15.30.4.1 Mode UniOSC.UniOSCMoveGameObject.movementMode
15.30.4.2

float UniOSC.UniOSCMoveGameObject.nearClipPlaneOffset = 1

15.30.4.3

Transform UniOSC.UniOSCMoveGameObject.transformToMove

15.31

UniOSC.UniOSCReceiver Class Reference

Uni OSC receiver.

Public Member Functions
• UniOSCReceiver ()
• UniOSCReceiver (int port)
• bool Connect ()
Connect this instance.

• void Disconnect ()
Disconnect this instance.

Properties
• int Port [get, set]
• int FrameNumber [get, set]

Events
• EventHandler< UniOSCEventArgs > OSCMessageReceived
• EventHandler< ExceptionEventArgs > OSCErrorOccured

15.31.1

Detailed Description

Uni OSC receiver.

15.31.2

Constructor & Destructor Documentation

15.31.2.1

UniOSC.UniOSCReceiver.UniOSCReceiver ( )

15.31.2.2

UniOSC.UniOSCReceiver.UniOSCReceiver ( int port )

Generated for monoflow by Doxygen

15.32 UniOSC.UniOSCRotateGameObject Class Reference

15.31.3

Member Function Documentation

15.31.3.1

bool UniOSC.UniOSCReceiver.Connect ( )

Connect this instance.

15.31.3.2

void UniOSC.UniOSCReceiver.Disconnect ( )

Disconnect this instance.

15.31.4

Property Documentation

15.31.4.1

int UniOSC.UniOSCReceiver.FrameNumber [get], [set]

15.31.4.2

int UniOSC.UniOSCReceiver.Port [get], [set]

15.31.5

Event Documentation

15.31.5.1

EventHandler UniOSC.UniOSCReceiver.OSCErrorOccured

15.31.5.2

EventHandler UniOSC.UniOSCReceiver.OSCMessageReceived

15.32

UniOSC.UniOSCRotateGameObject Class Reference

Rotates (localRotation) the hosting game object.
Inheritance diagram for UniOSC.UniOSCRotateGameObject:

MonoBehaviour
UniOSC.UniOSCEventTarget
UniOSC.UniOSCRotateGameObject

Public Member Functions
• override void OnEnable ()
Enable this component and reinitialize.

• override void OnOSCMessageReceived (UniOSCEventArgs args)
You should override this method in a subclass to handle the OSC data.

Public Attributes
•
•
•
•
•
•
•

Transform transformToRotate
string X_Address
string Y_Address
string Z_Address
float x_RotationFactor
float y_RotationFactor
float z_RotationFactor

Generated for monoflow by Doxygen

89

90

Class Documentation

Additional Inherited Members
15.32.1

Detailed Description

Rotates (localRotation) the hosting game object.
For every axis you have a separate OSC address to specify

15.32.2

Member Function Documentation

15.32.2.1

override void UniOSC.UniOSCRotateGameObject.OnEnable ( ) [virtual]

Enable this component and reinitialize.
If a property of the component is changed via the inspector we force a OnEnable to update the status of the
component. In general the component disconnects from all OSCConnections and try to find a new OSCConnection
to connect to with a matching port. If you change properties via code you should call this explicit.
Reimplemented from UniOSC.UniOSCEventTarget.

15.32.2.2

override void UniOSC.UniOSCRotateGameObject.OnOSCMessageReceived ( UniOSCEventArgs args )

[virtual]
You should override this method in a subclass to handle the OSC data.
Parameters
args

The current OSCEventArgs object

Implements UniOSC.UniOSCEventTarget.

15.32.3

Member Data Documentation

15.32.3.1

Transform UniOSC.UniOSCRotateGameObject.transformToRotate

15.32.3.2

string UniOSC.UniOSCRotateGameObject.X_Address

15.32.3.3

float UniOSC.UniOSCRotateGameObject.x_RotationFactor

15.32.3.4

string UniOSC.UniOSCRotateGameObject.Y_Address

15.32.3.5

float UniOSC.UniOSCRotateGameObject.y_RotationFactor

15.32.3.6

string UniOSC.UniOSCRotateGameObject.Z_Address

15.32.3.7

float UniOSC.UniOSCRotateGameObject.z_RotationFactor

15.33

UniOSC.UniOSCRotateGameObjectEditor Class Reference

Inheritance diagram for UniOSC.UniOSCRotateGameObjectEditor:
Generated for monoflow by Doxygen

15.34 UniOSC.UniOSCRotateGameObjectTouchOSCGyro Class Reference

Editor
UniOSC.UniOSCEventTargetEditor
UniOSC.UniOSCRotateGameObjectEditor

Public Member Functions
• override void OnInspectorGUI ()

Additional Inherited Members
15.33.1

Member Function Documentation

15.33.1.1

override void UniOSC.UniOSCRotateGameObjectEditor.OnInspectorGUI ( )

15.34

UniOSC.UniOSCRotateGameObjectTouchOSCGyro Class Reference

Inheritance diagram for UniOSC.UniOSCRotateGameObjectTouchOSCGyro:

MonoBehaviour
UniOSC.UniOSCEventTarget
UniOSC.UniOSCRotateGameObjectTouchOSCGyro

Public Member Functions
• override void OnEnable ()
Enable this component and reinitialize.

• override void OnOSCMessageReceived (UniOSCEventArgs args)
You should override this method in a subclass to handle the OSC data.

Public Attributes
•
•
•
•
•

Transform transformToRotate
float x_RotationFactor =90
float y_RotationFactor =90
float z_RotationFactor =90
float damping =1

Additional Inherited Members
15.34.1

Member Function Documentation

Generated for monoflow by Doxygen

91

92

Class Documentation

15.34.1.1

override void UniOSC.UniOSCRotateGameObjectTouchOSCGyro.OnEnable ( ) [virtual]

Enable this component and reinitialize.
If a property of the component is changed via the inspector we force a OnEnable to update the status of the
component. In general the component disconnects from all OSCConnections and try to find a new OSCConnection
to connect to with a matching port. If you change properties via code you should call this explicit.
Reimplemented from UniOSC.UniOSCEventTarget.

15.34.1.2

override void UniOSC.UniOSCRotateGameObjectTouchOSCGyro.OnOSCMessageReceived ( UniOSCEventArgs
args ) [virtual]

You should override this method in a subclass to handle the OSC data.
Parameters
args

The current OSCEventArgs object

Implements UniOSC.UniOSCEventTarget.

15.34.2

Member Data Documentation

15.34.2.1

float UniOSC.UniOSCRotateGameObjectTouchOSCGyro.damping =1

15.34.2.2

Transform UniOSC.UniOSCRotateGameObjectTouchOSCGyro.transformToRotate

15.34.2.3

float UniOSC.UniOSCRotateGameObjectTouchOSCGyro.x_RotationFactor =90

15.34.2.4

float UniOSC.UniOSCRotateGameObjectTouchOSCGyro.y_RotationFactor =90

15.34.2.5

float UniOSC.UniOSCRotateGameObjectTouchOSCGyro.z_RotationFactor =90

15.35

UniOSC.UniOSCScaleGameObject Class Reference

Uni OSC scale game object.
Inheritance diagram for UniOSC.UniOSCScaleGameObject:

MonoBehaviour
UniOSC.UniOSCEventTarget
UniOSC.UniOSCScaleGameObject

Public Member Functions
• override void OnEnable ()
Enable this component and reinitialize.

• override void OnOSCMessageReceived (UniOSCEventArgs args)
You should override this method in a subclass to handle the OSC data.
Generated for monoflow by Doxygen

15.36 UniOSC.UniOSCScriptTestEditor Class Reference

93

Public Attributes
• Transform transformToScale
• float scaleFactor = 1

Additional Inherited Members
15.35.1

Detailed Description

Uni OSC scale game object.

15.35.2

Member Function Documentation

15.35.2.1

override void UniOSC.UniOSCScaleGameObject.OnEnable ( ) [virtual]

Enable this component and reinitialize.
If a property of the component is changed via the inspector we force a OnEnable to update the status of the
component. In general the component disconnects from all OSCConnections and try to find a new OSCConnection
to connect to with a matching port. If you change properties via code you should call this explicit.
Reimplemented from UniOSC.UniOSCEventTarget.

15.35.2.2

override void UniOSC.UniOSCScaleGameObject.OnOSCMessageReceived ( UniOSCEventArgs args )

[virtual]
You should override this method in a subclass to handle the OSC data.
Parameters
args

The current OSCEventArgs object

Implements UniOSC.UniOSCEventTarget.

15.35.3

Member Data Documentation

15.35.3.1

float UniOSC.UniOSCScaleGameObject.scaleFactor = 1

15.35.3.2

Transform UniOSC.UniOSCScaleGameObject.transformToScale

15.36

UniOSC.UniOSCScriptTestEditor Class Reference

Editor for the administration of OSCconnections, mapping files.
Inheritance diagram for UniOSC.UniOSCScriptTestEditor:

EditorWindow
UniOSC.UniOSCScriptTestEditor

Public Member Functions
• void OnEnable ()
Generated for monoflow by Doxygen

94

Class Documentation

• void OnDisable ()

Properties
• static UniOSCScriptTestEditor Instance [get, set]
• static bool IsOpen [get]

15.36.1

Detailed Description

Editor for the administration of OSCconnections, mapping files.
You can also trace the OSC data flow .

15.36.2

Member Function Documentation

15.36.2.1

void UniOSC.UniOSCScriptTestEditor.OnDisable ( )

15.36.2.2

void UniOSC.UniOSCScriptTestEditor.OnEnable ( )

15.36.3

Property Documentation

15.36.3.1 UniOSCScriptTestEditor UniOSC.UniOSCScriptTestEditor.Instance [static], [get], [set]
15.36.3.2

bool UniOSC.UniOSCScriptTestEditor.IsOpen [static], [get]

15.37

UniOSC.UniOSCSessionFileObj Class Reference

OSC Session file class .
Inheritance diagram for UniOSC.UniOSCSessionFileObj:

ScriptableObject
UniOSC.UniOSCFileObj
UniOSC.UniOSCSessionFileObj

Public Member Functions
• void OnEnable ()
• void AddOSCSessionItem ()
Adds a new OSC Session item.

• void RemoveOSCSessionItem (UniOSCSessionItem obj)
Removes the OSC Session item from the list and destroys the item instance.

• void OnOSCMessageReceived (object sender, UniOSCEventArgs args)
Checks if we are in learning mode an writes the OSC message address into the address property of a session item
that is in learn mode(when user hold down the ’learn’ button in the editor.

Public Attributes
• List< UniOSCSessionItem > oscSessionItemList
Generated for monoflow by Doxygen

15.38 UniOSC.UniOSCSessionFileObjEditor Class Reference

95

Additional Inherited Members
15.37.1

Detailed Description

OSC Session file class .
Every Session file get stored as a .asset file. You can copy & paste a Session file to another Unity project but you
have to aware that sometimes Unity changes the serialization format. If you have any trouble go to ’Edit/Project
Settings/Editor’ and change the seriaization mode to ’Force Text’ and then switch back to ’Force Binary’

15.37.2

Member Function Documentation

15.37.2.1

void UniOSC.UniOSCSessionFileObj.AddOSCSessionItem ( )

Adds a new OSC Session item.

15.37.2.2

void UniOSC.UniOSCSessionFileObj.OnEnable ( )

15.37.2.3

void UniOSC.UniOSCSessionFileObj.OnOSCMessageReceived ( object sender, UniOSCEventArgs args )

Checks if we are in learning mode an writes the OSC message address into the address property of a session item
that is in learn mode(when user hold down the ’learn’ button in the editor.
Parameters
sender
args

15.37.2.4

Sender.
UniOSCEventArgs that contains the OSC message

void UniOSC.UniOSCSessionFileObj.RemoveOSCSessionItem ( UniOSCSessionItem obj )

Removes the OSC Session item from the list and destroys the item instance.
UniOSC.UniOSCSessionItem.OnOSCSessionItemDelete
Parameters
obj

UniOSCSessionItem to remove.

15.37.3

Member Data Documentation

15.37.3.1

List UniOSC.UniOSCSessionFileObj.oscSessionItemList

15.38

UniOSC.UniOSCSessionFileObjEditor Class Reference

Inheritance diagram for UniOSC.UniOSCSessionFileObjEditor:

Editor
UniOSC.UniOSCSessionFileObjEditor

Generated for monoflow by Doxygen

96

Class Documentation

Public Member Functions
• override void OnInspectorGUI ()

Static Public Member Functions
• static void Init ()
• static void OnGUI_OSCSessionData_Editor (UniOSCSessionFileObj obj, float screenWidth, float screen←Height)
• static void OnGUI_OSCSessionData_Inspector (UniOSCSessionFileObj obj, float screenWidth, float
screenHeight)

Static Public Attributes
• static GUIStyle style

15.38.1

Member Function Documentation

15.38.1.1

static void UniOSC.UniOSCSessionFileObjEditor.Init ( ) [static]

15.38.1.2

static void UniOSC.UniOSCSessionFileObjEditor.OnGUI_OSCSessionData_Editor ( UniOSCSessionFileObj obj,
float screenWidth, float screenHeight ) [static]

15.38.1.3

static void UniOSC.UniOSCSessionFileObjEditor.OnGUI_OSCSessionData_Inspector ( UniOSCSessionFileObj
obj, float screenWidth, float screenHeight ) [static]

15.38.1.4

override void UniOSC.UniOSCSessionFileObjEditor.OnInspectorGUI ( )

15.38.2

Member Data Documentation

15.38.2.1

GUIStyle UniOSC.UniOSCSessionFileObjEditor.style [static]

15.39

UniOSC.UniOSCSessionItem Class Reference

Uni OSC mapping item.

Public Member Functions
• UniOSCSessionItem ()
• UniOSCSessionItem (UniOSCSessionFileObj _hostObj)
Initializes a new instance of the UniOSC.UniOSCSessionItem class.

• void OnOSCSessionItemDelete ()
Removes this item from the UniOSCSessionFileObj host object.Afterwards it gets destroyed.

Public Attributes
•
•
•
•
•
•

UniOSCSessionFileObj hostObj
string address = ""
List< string > data = new List()
List< string > dataTypeList = new List()
bool isLearning
const int MAXWIDTH = 250
Generated for monoflow by Doxygen

15.40 UniOSC.UniOSCSessionItemEditor Class Reference

• const int MAXHEIGTH = 150
• bool collapsed = true

15.39.1

Detailed Description

Uni OSC mapping item.

 Stefan Schlupek 

15.39.2

Constructor & Destructor Documentation

15.39.2.1

UniOSC.UniOSCSessionItem.UniOSCSessionItem ( )

15.39.2.2

UniOSC.UniOSCSessionItem.UniOSCSessionItem ( UniOSCSessionFileObj _hostObj )

Initializes a new instance of the UniOSC.UniOSCSessionItem class.
Parameters
_hostObj

The UniOSCSessionFileObj object that host the item

15.39.3

Member Function Documentation

15.39.3.1

void UniOSC.UniOSCSessionItem.OnOSCSessionItemDelete ( )

Removes this item from the UniOSCSessionFileObj host object.Afterwards it gets destroyed.

15.39.4

Member Data Documentation

15.39.4.1

string UniOSC.UniOSCSessionItem.address = ""

15.39.4.2

bool UniOSC.UniOSCSessionItem.collapsed = true

15.39.4.3

List UniOSC.UniOSCSessionItem.data = new List()

15.39.4.4

List UniOSC.UniOSCSessionItem.dataTypeList = new List()

15.39.4.5 UniOSCSessionFileObj UniOSC.UniOSCSessionItem.hostObj
15.39.4.6

bool UniOSC.UniOSCSessionItem.isLearning

15.39.4.7

const int UniOSC.UniOSCSessionItem.MAXHEIGTH = 150

15.39.4.8

const int UniOSC.UniOSCSessionItem.MAXWIDTH = 250

15.40

UniOSC.UniOSCSessionItemEditor Class Reference

Inheritance diagram for UniOSC.UniOSCSessionItemEditor:

Editor
UniOSC.UniOSCSessionItemEditor

Generated for monoflow by Doxygen

97

98

Class Documentation

Public Member Functions
• void OnEnable ()

Static Public Member Functions
• static void OnGUI_Editor (UniOSCSessionItem obj)
• static void OnGUI_Inspector (UniOSCSessionItem obj)

15.40.1

Member Function Documentation

15.40.1.1

void UniOSC.UniOSCSessionItemEditor.OnEnable ( )

15.40.1.2

static void UniOSC.UniOSCSessionItemEditor.OnGUI_Editor ( UniOSCSessionItem obj ) [static]

15.40.1.3

static void UniOSC.UniOSCSessionItemEditor.OnGUI_Inspector ( UniOSCSessionItem obj ) [static]

15.41

UniOSC.UniOSCToggle Class Reference

With this class you can toggle most of the Unity Components on/off The data of the OSC message should be only
0(off) or 1(on)
Inheritance diagram for UniOSC.UniOSCToggle:

MonoBehaviour
UniOSC.UniOSCEventTarget
UniOSC.UniOSCToggle

Public Member Functions
• void UpdateComponentState ()
Updates the state of the component.

• override void OnEnable ()
Enable this component and reinitialize.

• override void OnOSCMessageReceived (UniOSCEventArgs args)
You should override this method in a subclass to handle the OSC data.

Public Attributes
• Component componentToToggle
• bool toggleState

Additional Inherited Members
15.41.1

Detailed Description

With this class you can toggle most of the Unity Components on/off The data of the OSC message should be only
0(off) or 1(on)
Generated for monoflow by Doxygen

15.42 UniOSC.UniOSCToggleEditor Class Reference

15.41.2

Member Function Documentation

15.41.2.1

override void UniOSC.UniOSCToggle.OnEnable ( ) [virtual]

99

Enable this component and reinitialize.
If a property of the component is changed via the inspector we force a OnEnable to update the status of the
component. In general the component disconnects from all OSCConnections and try to find a new OSCConnection
to connect to with a matching port. If you change properties via code you should call this explicit.
Reimplemented from UniOSC.UniOSCEventTarget.

15.41.2.2

override void UniOSC.UniOSCToggle.OnOSCMessageReceived ( UniOSCEventArgs args ) [virtual]

You should override this method in a subclass to handle the OSC data.
Parameters
args

The current OSCEventArgs object

Implements UniOSC.UniOSCEventTarget.

15.41.2.3

void UniOSC.UniOSCToggle.UpdateComponentState ( )

Updates the state of the component.
(enabled)

15.41.3

Member Data Documentation

15.41.3.1

Component UniOSC.UniOSCToggle.componentToToggle

15.41.3.2

bool UniOSC.UniOSCToggle.toggleState

15.42

UniOSC.UniOSCToggleEditor Class Reference

Inheritance diagram for UniOSC.UniOSCToggleEditor:

Editor
UniOSC.UniOSCEventTargetEditor
UniOSC.UniOSCToggleEditor

Public Member Functions
• override void OnEnable ()
• override void OnInspectorGUI ()

Protected Member Functions
• void ForceUpdate ()
Generated for monoflow by Doxygen

100

Class Documentation

Protected Attributes
• UniOSCToggle _targetToggle
• SerializedProperty ComponentToToggleProp
• SerializedProperty ToggleStateProp
• int _componentIndex = 0
• bool _updateFlag

15.42.1

Member Function Documentation

15.42.1.1

void UniOSC.UniOSCToggleEditor.ForceUpdate ( ) [protected]

15.42.1.2

override void UniOSC.UniOSCToggleEditor.OnEnable ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventTargetEditor.

15.42.1.3

override void UniOSC.UniOSCToggleEditor.OnInspectorGUI ( )

15.42.2

Member Data Documentation

15.42.2.1

int UniOSC.UniOSCToggleEditor._componentIndex = 0 [protected]

15.42.2.2 UniOSCToggle UniOSC.UniOSCToggleEditor._targetToggle [protected]
15.42.2.3

bool UniOSC.UniOSCToggleEditor._updateFlag [protected]

15.42.2.4

SerializedProperty UniOSC.UniOSCToggleEditor.ComponentToToggleProp [protected]

15.42.2.5

SerializedProperty UniOSC.UniOSCToggleEditor.ToggleStateProp [protected]

15.43

UniOSC.UniOSCTransformSender Class Reference

Inheritance diagram for UniOSC.UniOSCTransformSender:

MonoBehaviour
UniOSC.UniOSCEventDispatcher
UniOSC.UniOSCTransformSender

Public Member Functions
• override void OnEnable ()
• override void OnDisable ()

Public Attributes
• GameObject trackedGameObject
Generated for monoflow by Doxygen

15.44 UniOSC.UniOSCTransmitter Class Reference

Protected Member Functions
• override void _Update ()

Additional Inherited Members
15.43.1

Member Function Documentation

15.43.1.1

override void UniOSC.UniOSCTransformSender._Update ( ) [protected], [virtual]

Reimplemented from UniOSC.UniOSCEventDispatcher.

15.43.1.2

override void UniOSC.UniOSCTransformSender.OnDisable ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventDispatcher.

15.43.1.3

override void UniOSC.UniOSCTransformSender.OnEnable ( ) [virtual]

Reimplemented from UniOSC.UniOSCEventDispatcher.

15.43.2

Member Data Documentation

15.43.2.1

GameObject UniOSC.UniOSCTransformSender.trackedGameObject

15.44

UniOSC.UniOSCTransmitter Class Reference

Public Member Functions
•
•
•
•
•
•

UniOSCTransmitter ()
UniOSCTransmitter (string ipAddress, int port)
UniOSCTransmitter (IPAddress ipAddress, int port)
void Connect ()
void Close ()
bool SendOSCMessage (object sender, UniOSCEventArgs args)

Properties
• IPAddress IPAddress [get, set]
• int Port [get, set]

Events
• EventHandler< ExceptionEventArgs > OSCErrorOccured

15.44.1

Constructor & Destructor Documentation

15.44.1.1

UniOSC.UniOSCTransmitter.UniOSCTransmitter ( )

15.44.1.2

UniOSC.UniOSCTransmitter.UniOSCTransmitter ( string ipAddress, int port )

Generated for monoflow by Doxygen

101

102

Class Documentation

15.44.1.3

UniOSC.UniOSCTransmitter.UniOSCTransmitter ( IPAddress ipAddress, int port )

15.44.2

Member Function Documentation

15.44.2.1

void UniOSC.UniOSCTransmitter.Close ( )

15.44.2.2

void UniOSC.UniOSCTransmitter.Connect ( )

15.44.2.3

bool UniOSC.UniOSCTransmitter.SendOSCMessage ( object sender, UniOSCEventArgs args )

15.44.3

Property Documentation

15.44.3.1

IPAddress UniOSC.UniOSCTransmitter.IPAddress [get], [set]

15.44.3.2

int UniOSC.UniOSCTransmitter.Port [get], [set]

15.44.4

Event Documentation

15.44.4.1

EventHandler UniOSC.UniOSCTransmitter.OSCErrorOccured

Generated for monoflow by Doxygen



---

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : No
Page Count                      : 122
Page Mode                       : UseOutlines
Author                          : 
Title                           : 
Subject                         : 
Creator                         : LaTeX with hyperref package
Producer                        : pdfTeX-1.40.14
Create Date                     : 2015:02:27 15:15:17+01:00
Modify Date                     : 2015:02:27 15:15:17+01:00
Trapped                         : False
PTEX Fullbanner                 : This is MiKTeX-pdfTeX 2.9.4902 (1.40.14)

EXIF Metadata provided by EXIF.tools