Link Search Menu Expand Document

arena-py API v1.3.0

arena.attributes.data

class Data(arena.attributes.attribute.Attribute):

Data attribute class to manage its properties in the ARENA: Wraps all attributes in JSON. Usage: data=Data(...)

Parameters
  • dict animation: Animate and tween values. More properties at https://aframe.io/docs/1.5.0/components/animation.html A-Frame Animation component. Easing properties are detailed at <https: //easings.net> easings.net. (optional)
  • dict animation_mixer: A list of available animations can usually be found by inspecting the model file or its documentation. All animations will play by default. To play only a specific set of animations, use wildcards: animation-mixer='clip: run_*'. Requires object_type: gltf-model. More properties at <https: //github.com/n5ro/aframe-extras/tree/master/src/loaders#animation> A-Frame Extras Animation. (optional)
  • dict 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. (optional)
  • dict attribution: Attribution Component. Saves attribution data in any entity. (optional)
  • dict blip: When the object is created or deleted, it will animate in/out of the scene instead of appearing/disappearing instantly. Must have a geometric mesh. (optional)
  • dict 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. (optional)
  • bool buffer: Transform geometry into a BufferGeometry to reduce memory usage at the cost of being harder to manipulate (geometries only: box, circle, cone, ...). Defaults to 'True' (optional)
  • dict click_listener: Object will listen for mouse events like clicks. (optional)
  • **str collision_listener: Name of the collision-listener, default can be empty string. Collisions trigger click events. Requires scene-options**: physics. (optional)
  • str color: </strong>DEPRECATED</em>: data.color is *deprecated for primitive geometry, use data.material.color instead.* (deprecated)</li>
  • dict dynamic_body: *DEPRECATED*: data.dynamic-body is *deprecated, use data.physx-body instead.* (deprecated)
  • **dict gltf_model_lod: Simple switch between the default gltf-model and a detailed one when a user camera is within specified distance. Requires object_type**: gltf-model. (optional)
  • dict gltf_morph: Allows you to target and control a gltf model's morphTargets created in Blender. Requires object_type: gltf-model. More properties at <https: //github.com/elbobo/aframe-gltf-morph-component> A-Frame GLTF Morph component. (optional)
  • dict goto_landmark: Teleports user to the landmark with the given name. Requires click-listener attribute. (optional)
  • dict goto_url: Load new URL when object is clicked. Requires click-listener attribute. (optional)
  • bool hide_on_enter_ar: Hide object when entering AR. Remove component to not hide. (optional)
  • bool hide_on_enter_vr: Hide object when entering VR. Remove component to not hide. (optional)
  • dict impulse: </strong>DEPRECATED</em>: data.impulse is *deprecated, use data.physx-force-pushable instead.* (deprecated)</li>
  • dict jitsi_video: Apply a jitsi video source to the geometry. (optional)
  • dict 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). (optional)
  • str look_at: The look-at component defines the behavior for an entity to dynamically rotate or face towards another entity or position. Use '#my-camera' to face the user camera, otherwise can take either a vec3 position or a query selector to another entity. (optional)
  • dict material: The material properties of the object's surface. More properties at <https: //aframe.io/docs/1.5.0/components/material.html> A-Frame Material. (optional)
  • dict material_extras: Define extra material properties, namely texture encoding, whether to render the material's color and render order. Requires material attribute. More properties at <https: //threejs.org/docs/#api/en/materials/Material> THREE.js Material. (optional)
  • dict model_container: Overrides absolute size for a 3D model. The model can be a glTF, glb, obj, or any other supported format. The model will be rescaled to fit to the sizes specified for each axes. (optional)
  • **dict modelUpdate: The GLTF-specific modelUpdate attribute is an object with child component names as keys. The top-level keys are the names of the child components to be updated. The values of each are nested position and rotation attributes to set as new values, respectively. Either position or rotation can be omitted if unchanged. Requires object_type**: gltf-model. (optional)
  • dict multisrc: Define multiple visual sources applied to an object. Requires material attribute. (optional)
  • str parent: Parent's object_id. Child objects inherit attributes of their parent, for example scale and translation. (optional)
  • **dict physx_body: Turns an entity into a PhysX rigid body. This is the main component for creating physics objects. There are 3 types of rigid bodies: dynamic objects that have physics simulated on them, static objects that cannot move, and kinematic objects that can be moved programmatically but not by simulation. Requires scene-options**: physics. (optional)
  • **dict physx_force_pushable: Makes a physx-body object pushable by the user. Requires click-listener attribute. Requires scene-options**: physics. (optional)
  • **bool physx_grabbable: Makes a physx-body object grabbable by the user's hands. Requires scene-options**: physics. Defaults to 'True' (optional)
  • **dict physx_joint: Creates a PhysX joint between an ancestor rigid body and a target rigid body. Position and rotation of the entity will be used to create the corresponding joint. Requires scene-options**: physics. (optional)
  • **dict physx_joint_constraint: Adds a constraint to a physx-joint. Supported joints are D6, Revolute and Prismatic. Can only be used on an entity with the physx-joint component. Requires scene-options**: physics. (optional)
  • **dict physx_joint_driver: Creates a driver which exerts force to return the joint to the initial position with the given velocity characteristics. Can only be used on an entity with a physx-joint component. Currently only supports D6 joint type. Requires scene-options**: physics. (optional)
  • **dict physx_material: Controls physics properties for individual shapes or rigid bodies. Can be set on an entity with physx-body or on shapes contained within it. Requires scene-options**: physics. (optional)
  • dict position: 3D object position. (optional)
  • dict remote_render: Whether or not an object should be remote rendered [Experimental]. (optional)
  • dict rotation: 3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format. (optional)
  • dict scale: 3D object scale. (optional)
  • bool screenshareable: Whether or not a user can screenshare on an object. Defaults to 'True' (optional)
  • dict shadow: The shadow component enables shadows for an entity and its children. Adding the shadow component alone is not enough to display shadows in your scene. We must have at least one light with castShadow: true enabled. (optional)
  • bool show_on_enter_ar: Show object when entering AR. Hidden otherwise. (optional)
  • bool show_on_enter_vr: Show object when entering VR. Hidden otherwise. (optional)
  • bool skipCache: Disable retrieving the shared geometry object from the cache. (geometries only: box, circle, cone, ...). Defaults to 'False' (optional)
  • dict sound: The sound component defines the entity as a source of sound or audio. The sound component can be positional and is thus affected by the component's position. More properties at <https: //aframe.io/docs/1.5.0/components/sound.html> A-Frame Sound. (optional)
  • dict spe_particles: GPU based particle systems in A-Frame. More properties at <https: //github.com/harlyq/aframe-spe-particles-component> A-Frame SPE Particles component. (optional)
  • dict static_body: *DEPRECATED*: data.static-body is *deprecated, use data.physx-body instead.* (deprecated)
  • str submodel_parent: When this object is parented to a hierarchical model, it attaches to a named sub-component of that model instead of the root position. Requires parent attribute. Defaults to '' (optional)
  • dict textinput: Opens an HTML prompt when clicked. Sends text input as an event on MQTT. Requires click-listener attribute. (optional)
  • str url: Use File Store paths under 'store/users/username', see CDN and other storage options in the description above. (optional)
  • dict video_control: Adds a video to an entity and controls its playback. (optional)
  • bool visible: Whether object is visible. Property is inherited. Defaults to 'True' (optional)
    • </ul> </div>
    Data(**kwargs)
    @classmethod
    def update_data(cls, data, new_data):
    Inherited Members
    </section> </main> </div>