types/tween.proto

Table of Contents

• types/tween.proto

  • Tween

  • TweenSupport

• Scalar Value Types

Top

types/tween.proto

Tween

An in-progress transition between two values. The values themselves should be defined in an enclosing message.

Typically an enclosing message will define three properties, the value, the tween, and the target value.

Example definition

message WaterHeight { // The current or expected height of water, in meters float height = 1; // Describe how the height changes or should change over time Tween height_tween = 2; // Read-only, the target height at the end of a transition float target_height = 3; }

Field	Type	Label	Description
progress	float		Read-only [0-100], how far along the transition (in time) are we.
total_duration	google.protobuf.Duration		how long the transition will last in total

TweenSupport

Denote different types of tween support. Clients may use this to control performance sensitive areas by enabling or disabling tweening when support is not native, for example

Name	Number	Description
TWEEN_SUPPORT_UNSPECIFIED	0	Tween support is not specified.
NO_SUPPORT	1	The device does not support tweening
NATIVE	2	The device natively supports tweening. Natively typically means with minimal performance impact (i.e. no network)
EMULATED	3	The device supports tweening via emulation. Typically tweening is implemented by the Smart Core driver or a supervisor node and not the device itself.
FIXED	4	The device tweens values, but the duration or rate is fixed and cannot be adjusted. For example a motor might only have one speed when operating an adjustable desk

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)