Plane

Plane Geometry

All wire objects have a set of basic attributes {object_id, action, type, persist, data}. The data attribute defines the object-specific attributes

Plane Attributes

Attribute	Type	Default	Description	Required
object_id	string		A uuid or otherwise unique identifier for this object	Yes
persist	boolean	`True`	Persist this object in the database (default true = persist on server)	Yes
type	string; Must be: `object`	`'object'`	AFrame 3D Object	Yes
action	string; One of: `['create', 'delete', 'update', 'clientEvent']`	`'create'`	One of 3 basic Create/Update/Delete actions or a special client event action (e.g. a click)	Yes
ttl	integer		When applied to an entity, the entity will remove itself from DOM after the specified number of seconds. Update is allowed, which will reset the timer to start from that moment.	No
data	Plane data		Plane Data	Yes

Plane Data Attributes

Attribute	Type	Default	Description	Required
object_type	string; Must be: `plane`	`plane`	3D object type.	Yes
height	number	`1`	height	Yes
segmentsHeight	number	`1`	segments height	No
segmentsWidth	number	`1`	segments width	No
width	number	`1`	width	Yes
parent	string		Parent’s object_id. Child objects inherit attributes of their parent, for example scale and translation.	No
position	position	`{'x': 0, 'y': 0, 'z': 0}`	3D object position	No
rotation	rotation	`{'w': 1, 'x': 0, 'y': 0, 'z': 0}`	3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.	No
scale	scale		3D object scale	No
animation	animation		Animate and tween values.	No
armarker	armarker		A location marker (such as an AprilTag, a lightAnchor, or an UWB tag), used to anchor scenes, or scene objects, in the real world.	No
click-listener	boolean		Object will listen for clicks	No
box-collision-listener	box-collision-listener		Listen for bounding-box collisions with user camera and hands. Must be applied to an object or model with geometric mesh. Collisions are determined by course bounding-box overlaps	No
collision-listener	string		Name of the collision-listener, default can be empty string. Collisions trigger click events	No
color	string	`'#ffa500'`	(deprecated) Color of the material. Please use material.color instead.	No
dynamic-body	dynamic-body		Physics type attached to the object.	No
goto-landmark	goto-landmark		Teleports user to the landmark with the given name; Requires click-listener	No
goto-url	goto-url		Goto given URL; Requires click-listener	No
hide-on-enter-ar	boolean; Must be: `True`	`True`	Hide object when entering AR. Remove component to not hide	No
hide-on-enter-vr	boolean; Must be: `True`	`True`	Hide object when entering VR. Remove component to not hide	No
impulse	impulse		The force applied using physics. Requires click-listener	No
landmark	landmark		Define entities as a landmark; Landmarks appears in the landmark list and you can move (teleport) to them; You can define the behavior of the teleport: if you will be at a fixed or random distance, looking at the landmark, fixed offset or if it is constrained by a navmesh (when it exists)	No
material-extras	material-extras		Define extra material properties, namely texture encoding, whether to render the material’s color and render order. The properties set here access directly Three.js material component.	No
shadow	shadow		shadow	No
sound	sound		The sound component defines the entity as a source of sound or audio. The sound component is positional and is thus affected by the component’s position.	No
textinput	textinput		Opens an HTML prompt when clicked. Sends text input as an event on MQTT. Requires click-listener.	No
url	string		Model URL. Store files paths under ‘store/users/' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with `https://arena-cdn.conix.io/` (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)	No
screenshareable	boolean	`True`	Whether or not a user can screenshare on an object	No
video-control	video-control		Video Control	No
attribution	attribution		Attribution Component. Saves attribution data in any entity.	No
particle-system	particle-system		Particle system component for A-Frame.	No
spe-particles	spe-particles		GPU based particle systems in A-Frame.	No
buffer	boolean	`True`	Transform geometry into a BufferGeometry to reduce memory usage at the cost of being harder to manipulate (geometries only: box, circle, cone, …).	No
jitsi-video	jitsi-video		Apply a jitsi video source to the geometry	No
material	material	`{'color': '#7f7f7f'}`	The material properties of the object’s surface.	No
multisrc	multisrc		Define multiple visual sources applied to an object.	No
skipCache	boolean	`True`	Disable retrieving the shared geometry object from the cache. (geometries only: box, circle, cone, …).	No