Package-level declarations

Types

Link copied to clipboard
@MainThread
class AmbientAudioComponent : Component

A Component used to create ambient audio effects in the scene, such as ambient sound effects, ambient music, and more.

Link copied to clipboard
@MainThread
class AnchorComponent : Component

The Component that defines a spatial anchoring relationship between entities and real-world objects.

Link copied to clipboard
class AnchorEntity @MainThread constructor(anchorTarget: AnchorTarget) : Entity

An entity extension that acts as an anchor, establishing and maintaining the pose of entities within a scene.

Link copied to clipboard

AnimationResourceLibraryComponent is a component designed to manage animation resources.

Link copied to clipboard
class AttachmentPanelComponent(context: Context, width: Int = WRAP_CONTENT, height: Int = WRAP_CONTENT, alignment: AttachmentPanelComponent.Alignment = Alignment.UNSPECIFIED) : Component

Component that allows attaching a 2D Android View to an Entity in spatial space.

Link copied to clipboard

A Component that manages audio mix groups for spatial audio processing.

Link copied to clipboard

A Component that manages audio resources as a key-value dictionary for organized audio playback.

Link copied to clipboard

Provides BlendShape (morph target) weight control for an Entity's model, with optional subset workflows for managing groups of BlendShapes.

Link copied to clipboard

Represents the bounding box for 3D content. All measurements are expressed in meters (m).

Link copied to clipboard
@MainThread
class ChannelAudioComponent : Component

A Component that can be added to an entity to enable channel audio effects.

Link copied to clipboard
@MainThread
class CollisionComponent : Component

A Component responsible for managing collision settings and operations, including collision detection and response.

Link copied to clipboard
@MainThread
open class Component : JsonModel

The representation of a Component in the ECS architecture.

Link copied to clipboard

A Component that emits directional light along an entity's local forward (-Z) axis.

Link copied to clipboard
@MainThread
class DrawOrderGroup

The identifier that defines a specific draw order group for rendering management.

Link copied to clipboard

The Component that defines a draw order group for ModelComponent and ParticleComponent.

Link copied to clipboard

The base class for all entities in a scene.

Link copied to clipboard

Encapsulates conditions for querying entities. It allows checking whether an entity meets a specific condition through a condition function.

Link copied to clipboard

The Component that configures the scale of the environment image based light.

Link copied to clipboard
sealed class EventSource

The base class for defining sources of events.

Link copied to clipboard
typealias ExtraComponentDataSyncer = (ComponentType, Entity) -> Component?
Link copied to clipboard
@MainThread
class GroundShadowComponent : Component

A Component that adds a ground shadow to the entity.

Link copied to clipboard
@MainThread
class HoverEffectComponent : Component

A Component that apply visual effect when user interacts with it.

Link copied to clipboard

A Component that provides localized image-based lighting (IBL) for entities with an ImageBasedLightReceiverComponent.

Link copied to clipboard

A Component that enables an entity to receive image-based lighting (IBL) from the source entity having an ImageBasedLightComponent.

Link copied to clipboard

Defines the source textures for image-based lighting (IBL) in a scene.

Link copied to clipboard
@MainThread
class InteractableComponent : Component

The Component that marks an entity as interactable, allowing it to receive and process input events.

Link copied to clipboard
enum LoadType : Enum<LoadType>

Enum representing different ways of loading data.

Link copied to clipboard
@MainThread
class LookAtComponent : Component

A Component that controls the "look at" behavior of entities in 3D space, allowing entities to face specific targets (such as viewers or other entities) and providing control over alignment methods and forward direction.

Link copied to clipboard

Enumeration defining possible forward direction axes for the LookAtComponent in 3D spatial simulation. Specifies which axis an entity should use as its forward direction when implementing "look at" behavior.

Link copied to clipboard

Enumeration defining target types for the LookAtComponent in 3D spatial simulation. Specifies what an entity should face when implementing "look at" behavior.

Link copied to clipboard
@MainThread
class ModelComponent : Component

A Component that renders 3D models.

Link copied to clipboard

A class for rendering a model with specified mesh and materials.

Link copied to clipboard
enum ModelFormat : Enum<ModelFormat>

Represents supported 3D model formats.

Link copied to clipboard
@MainThread
class ObjectAudioComponent : Component

A Component used to create spatial audio effects in the scene, such as spatial sound effects, spatial music, and so on.

Link copied to clipboard
@MainThread
class OpacityControllerComponent(@FloatRange(from = 0.0, to = 1.0) opacity: Float = 1.0f) : Component

An Component that controls the opacity of an entity and its descendants. It works hierarchically, the opacity on antecedent will be combined by multiplying the opacity together.

Link copied to clipboard
@MainThread
class ParticleComponent : Component

A Component that is used to play particle effects in the scene.

Link copied to clipboard
@MainThread
class PhysicsForceComponent : Component

A Component that applies constant force or torque (in local coordinate space) to drive physics-based motion on an entity. Force is measured in newtons (N). Torque is measured in newton-meters (N·m).

Link copied to clipboard

A Component that directly sets an entity’s linear and angular velocities.

Link copied to clipboard
@MainThread
class PhysicsWorldComponent : Component

A Component that creates a new physics world for the entity and allows manipulation of physics simulation parameters including gravity, KinematicCollisionReportMode, SolverIterations, and SimulationClock.

Link copied to clipboard
@MainThread
class PointLightComponent : Component

A Component that emits omnidirectional light from the entity's position.

Link copied to clipboard
@MainThread
class PortalComponent : Component

A Component that enables entity surfaces to act as portals to a target world (the targetEntity EC tree) and should be used in conjunction with PortalMaterial.

Link copied to clipboard

A Component that enables an entity (in the target world) and its descendants to traverse through a portal. This component should be utilized with PortalComponent, PortalWorldComponent, and PortalMaterial.

Link copied to clipboard
@MainThread
class PortalWorldComponent : Component

A Component that transforms an entity and its descendants into a separate world, visible only through a portal. This component should be used with PortalComponent, PortalCrossableComponent, and PortalMaterial.

Link copied to clipboard
@MainThread
class RigidBodyComponent : Component

A Component responsible for defining the properties of the rigid body, including its RigidBodyMode, MassProperties, CollisionDetectionMode, linear and angular damping, gravity influence, and constraints on translation or rotation in specific directions.

Link copied to clipboard

Represents a scene.

Link copied to clipboard

The context used to update scene.

Link copied to clipboard
sealed interface SpatialCoordinateSpace

Coordinate space for spatial objects. Describes a scene in the SpatialView using the right-handed coordinate system, with the origin described by the origin entity.

Link copied to clipboard
@MainThread
class SpotLightComponent : Component

A Component that emits conical light along the entity's forward (-Z) axis.

Link copied to clipboard

A Component that that provides image-based lighting (IBL) for the entire scene.

Link copied to clipboard
abstract class System

Represents a system in the Entity-Component-System (ECS) architecture.

Link copied to clipboard
@MainThread
class TransformComponent : Component

A Component that manipulates the scale, rotation, and position of the entity.

Link copied to clipboard
@MainThread
class VideoComponent : Component

A Component that can be constructed using a provided VideoMaterial and MeshResource. With the given parameters, this component can be used to render a 3D video.

Link copied to clipboard
@MainThread
class VideoPlayerComponent : Component

A Component that can be constructed with CypressMediaPlayer, VideoMaterial, and MeshResource, allowing you to render a 3D video.

Link copied to clipboard
sealed interface ViewCoordinateSpace

Coordinate space for views, including the SpatialUI View, Standard Android View.