1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
define_api_id!(0x3c5a_8c47_30ab_ec47, "world-v4");
pub use crate::world_v0::EntityHandle;
pub use crate::world_v0::MeshHandle;
pub use crate::world_v0::Ray;
pub use crate::world_v0::Value;
pub use crate::world_v0::ENTITY_HANDLE_INVALID;
pub use crate::world_v2::DataHandle;
pub use crate::world_v2::ResourceHandleRepr;
pub use crate::world_v3::RaycastHit;
use crate::FFIResult;
use bytemuck::Pod;
use bytemuck::Zeroable;
#[ark_api_macros::ark_bindgen(imports = "ark-world-v4")]
mod world {
use super::*;
bitflags! {
#[repr(C)]
#[derive(Pod, Zeroable)]
pub struct RaycastQueryOptions : u32 {
/// For raycasts, skips hits where t = min_t or in other words
/// direct hits inside a solid primitive.
const IGNORE_INTERIOR_HITS = 0b0010_0000;
}
}
impl Default for RaycastQueryOptions {
fn default() -> Self {
Self::empty()
}
}
#[derive(Copy, Clone, Default, Debug, Pod, Zeroable)]
#[repr(C)]
pub struct RaycastQueryWithOptions {
pub ray: Ray,
pub layer_mask: u64,
pub ignore_entity: EntityHandle,
pub max_distance: f32,
pub options: RaycastQueryOptions,
}
#[derive(Copy, Clone, Default, Debug, Pod, Zeroable)]
#[repr(C)]
pub struct SpherecastQuery {
pub ray: Ray,
pub layer_mask: u64,
pub ignore_entity: EntityHandle,
pub max_distance: f32,
pub options: RaycastQueryOptions,
/// When zero, this is just a raycast.
pub spherecast_radius: f32,
pub _pad: u32,
}
#[derive(Copy, Clone, Debug, Pod, Zeroable)]
#[repr(C)]
pub struct SpatialQueryHit {
pub entity: EntityHandle,
pub point: [f32; 3],
/// The distance along the ray.
///
/// The hits are sorted by this distance when returned from raycast and spherecast queries.
/// In a raycast this is equal to `ray.origin.distance(hit.position)`,
/// but in a spherecast it can be different.
pub distance: f32,
pub normal: [f32; 3],
pub _pad: u32,
}
impl SpatialQueryHit {
pub fn invalid() -> Self {
Self {
entity: ENTITY_HANDLE_INVALID,
point: [f32::NAN; 3],
distance: f32::NAN,
normal: [f32::NAN; 3],
_pad: 0,
}
}
}
#[deprecated(note = "Use EntityLocalTransformConformal3 instead")] // 2022-09-13
#[derive(Clone, Copy, Debug, Pod, Zeroable)]
#[repr(C)]
pub struct EntityTransform {
/// Vec3
pub translation: [f32; 3],
/// Quaternion, normalized
pub rotation: [f32; 4],
/// Vec3
pub scale: [f32; 3],
}
#[deprecated(note = "Use EntityLocalTransformConformal3 instead")] // 2022-09-13
#[derive(Clone, Copy, Debug, Pod, Zeroable)]
#[repr(C)]
pub struct EntityTransformAffine3 {
/// Mat3 (rotation, scale)
pub rotation_scale: [f32; 9],
/// Vec3 (translation)
pub translation: [f32; 3],
}
#[derive(Clone, Copy, Debug, Pod, Zeroable)]
#[repr(C)]
pub struct EntityTransformConformal3 {
/// Vec4 (translation, scale)
pub translation_and_scale: [f32; 4],
/// Quat (rotation)
pub rotation: [f32; 4],
}
#[derive(Clone, Copy, Debug, Pod, Zeroable)]
#[repr(C)]
pub struct EntityMeshStyleTint {
/// Vec4 (rgba)
pub tint: [f32; 4],
}
#[derive(Clone, Copy, Debug, Pod, Zeroable)]
#[repr(C)]
pub struct EntityRenderEnable {
/// 0 = off, 1 = on,
pub enable: u32,
}
#[derive(Clone, Copy, Debug, Pod, Zeroable)]
#[repr(C)]
pub struct EntityBounds {
// Vec3
pub bounding_box_min: [f32; 3],
// Vec3
pub bounding_box_max: [f32; 3],
// Radius from bounding box center
pub bounding_sphere_radius: f32,
}
#[derive(Clone, Copy, Debug, Pod, Zeroable)]
#[repr(C)]
pub struct EntityVelocity {
// Vec3, linear velocity
pub positional: [f32; 3],
// Vec3, angular velocity, axis-angle. length == velocity
pub rotational: [f32; 3],
}
#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq)]
#[repr(u32)]
#[non_exhaustive]
pub enum EntityValueType {
/// Expects data with the same layout and size as the struct `EntityTransform`
#[deprecated(note = "Use EntityLocalTransformConformal3 instead")] // 2022-09-13
EntityLocalTransform = 0,
/// Expects data with the same layout and size as the struct `EntityMeshStyleTint`
/// Will set the tint on all mesh styles that are used by this entity. This assumes
/// each entity uses its own `MeshStyle`.
EntityRenderTint = 1,
/// Expects data with the same layout and size as the struct `EntityRenderEnable`
EntityRenderEnable = 2,
/// Expects data with the same layout and size as the struct `EntityTransform`
#[deprecated(note = "Use EntityWorldTransformConformal3 instead")] // 2022-09-13
EntityWorldTransform = 3,
/// Expects data with the same layout and size as the struct `EntityBounds`
EntityLocalBounds = 4,
/// Expects data with the same layout and size as the struct `EntityVelocity`
EntityPhysicsVelocity = 5,
/// Expects data with the same layout and size as the struct `EntityStateFlags`
EntityStateFlags = 6,
/// Expects data with the same layout and size as the struct `EntityTransformAffine3`
#[deprecated(note = "Use EntityWorldTransformConformal3 instead")] // 2022-09-13
EntityWorldTransformAffine3 = 7,
/// Expects data with the same layout and size as the struct `EntityTransformConformal3`
EntityLocalTransformConformal3 = 8,
/// Expects data with the same layout and size as the struct `EntityTransformConformal3`
EntityWorldTransformConformal3 = 9,
}
impl EntityValueType {
pub fn size_of_element(&self) -> u32 {
let size = match self {
Self::EntityLocalTransform | Self::EntityWorldTransform => {
std::mem::size_of::<EntityTransform>()
}
Self::EntityRenderTint => std::mem::size_of::<EntityMeshStyleTint>(),
Self::EntityRenderEnable => std::mem::size_of::<EntityRenderEnable>(),
Self::EntityLocalBounds => std::mem::size_of::<EntityBounds>(),
Self::EntityPhysicsVelocity => std::mem::size_of::<EntityVelocity>(),
Self::EntityStateFlags => std::mem::size_of::<EntityStateFlags>(),
Self::EntityWorldTransformAffine3 => std::mem::size_of::<EntityTransformAffine3>(),
Self::EntityLocalTransformConformal3 | Self::EntityWorldTransformConformal3 => {
std::mem::size_of::<EntityTransformConformal3>()
}
};
size as u32
}
}
bitflags! {
/// The state of a requested entity value
#[repr(C)]
#[derive(Default, Pod, Zeroable)]
pub struct EntityStateFlags : u32 {
const VALID = 0b0000_0001;
const TRANSFORM_CHANGED = 0b0000_0010;
const PHYSICS_VELOCITY_CHANGED = 0b0000_0100;
const BOUNDS_CHANGED = 0b0000_1000;
}
}
bitflags! {
#[repr(C)]
#[derive(Pod, Zeroable)]
pub struct EntityDebugOptions : u32 {
const PHYSICS_SHAPE_DEBUG_RENDERING_ENABLE = 0b0000_0001;
}
}
/// `min_x`/`min_y`/`width`/`height` are in World units, same as the size the text will appear in the world if you apply no scaling
#[derive(Debug, Copy, Clone, Pod, Zeroable)]
#[repr(C)]
pub struct MeasuredTextSize {
pub min_x: f32,
pub min_y: f32,
pub width: f32,
pub height: f32,
}
#[derive(Debug, Copy, Clone, Pod, Zeroable)]
#[repr(C)]
pub struct AudioClipResource {
pub handle: ResourceHandleRepr,
}
#[derive(Default, Copy, Clone, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct DominantColorWithArea {
pub color: [u8; 4], // sRGBA vertex color
pub area: f32,
}
/// Error value that is returned from get/set entity value functions.
#[derive(Default, Copy, Clone, Debug, PartialEq)]
#[non_exhaustive]
#[repr(u32)]
pub enum EntityValueError {
/// No error occurred.
#[default]
Undefined = 0,
/// The component parameter value is a NaN value.
NanValue = 1,
/// The component parameter value is an infinite value.
InfiniteParamValue = 2,
/// The supplied component type is invalid.
InvalidComponentType = 3,
/// The supplied component parameter id is invalid.
InvalidComponentParameterId = 4,
/// The component did not exist.
InvalidComponent = 5,
/// Invalid supplied entity key
InvalidEntityKey = 6,
/// Invalid parent of parent (a parent was pointing to an invalid entity)
InvalidParentOfParent = 7,
/// Trying to set an entity value that is incompatible with the component parameter value.
IncompatibleValueType = 8,
/// Trying to set an entity value that is incompatible with the component parameter value.
IncompatibleValue = 9,
/// Could not set the entity component parameter value.
Unsettable = 10,
/// Could not get the entity component parameter value.
Ungettable = 11,
/// The component was not available.
NotAvailable = 12,
/// Trying to set an unnormalized rotation on an entity
UnnormalizedRotation = 13,
}
#[derive(Default, Copy, Clone, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct EntityPair {
pub a: EntityHandle,
pub b: EntityHandle,
}
#[derive(Copy, Clone, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct CollisionInfo {
/// The entities involved in the collision. We include it here since the order of it affects the interpretation of the `impulse_sum` vector.
pub entities: EntityPair,
pub world_pos_approximate: [f32; 3],
// some padding for future extensibility
pub _pad0: u32,
/// The sum of the impulses in this collision. In the direction applied to `entities.a`.
pub impulse_sum: [f32; 3],
pub _pad1: u32,
}
extern "C" {
#[deprecated(note = "use `spherecast` instead")] // since 2021-09-23
#[deprecated_infallible]
pub fn raycast(raycast: &RaycastQueryWithOptions) -> RaycastHit;
#[deprecated(note = "use `spherecast_batched` instead")] // since 2021-09-23
#[deprecated_infallible]
pub fn raycast_batched(raycasts: &[RaycastQueryWithOptions], hits: &mut [RaycastHit]);
pub fn spherecast(raycast: &SpherecastQuery) -> RaycastHit;
pub fn spherecast_batched(raycasts: &[SpherecastQuery], hits: &mut [RaycastHit]);
/// Sets the debug name of a data object (useful for debugging data memory usage and leaks etc.)
#[deprecated_infallible]
pub fn set_data_debug_name(data: DataHandle, name: &str);
pub fn get_data_debug_name(data: DataHandle) -> String;
// An empty slice will mean to apply the options to all entities in the world.
pub fn set_entity_debug_options(
entities: &[EntityHandle],
debug_options: &EntityDebugOptions,
);
pub fn set_entity_values(
entities: &[EntityHandle],
value_type: EntityValueType,
data: &[u8],
);
pub fn get_entity_values(
entities: &[EntityHandle],
value_type: EntityValueType,
out_data: &mut [u8],
);
/// Try setting an entity component parameter value.
///
/// - `entity`: The entity handle that has the component on which the value will be set.
/// - `component_type`: ([ComponentType][crate::world_v2::ComponentType]): the component that is to be updated.
/// - `component_param_id`: The component parameter id that specifies which parameter is to be updated.
/// - `new_component_value`: The new value for the component parameter. This should not contain NaN values.
/// - `out_error_info`: Error values are written to this enum field. Make sure to allocate enough memory.
///
/// This can fail if an invalid entity handle, component type, parameter id, or value was supplied.
/// Make sure the entity and component actually exist and use the right value for it.
pub fn try_set_entity_value(
entity: EntityHandle,
component_type: u64,
component_param_id: u32,
new_component_value: &Value,
out_error_info: &mut EntityValueError,
) -> FFIResult<()>;
/// Try fetching an entity component parameter value.
///
/// - `entity`: The entity handle that has the component from which the value will be fetched.
/// - `component_type` ([`crate::world_v2::ComponentType`]): the component with the field that is to be fetched.
/// - `component_param_id`: The component parameter id that specifies which parameter is to be fetched.
/// - `out_component_value`: The returned component parameter value. Make sure to allocate enough memory.
/// - `out_error_info`: Error values are written to this enum field. Make sure to allocate enough memory.
///
/// This can fail if an invalid entity handle, component type, or parameter id was supplied.
/// Make sure the entity and component actually exist.
pub fn try_get_entity_value(
entity: EntityHandle,
component_type: u64,
component_param_id: u32,
out_component_value: &mut Value,
out_error_info: &mut EntityValueError,
) -> FFIResult<()>;
/// Measure how large text will be when mesh-generated and rendered. Needed for some layout tasks in sandbox.
/// Formatting information is embedded in the text with the same encoding as is used for display, so just pass
/// the string in here.
pub fn measure_formatted_text(text: DataHandle, size: &mut MeasuredTextSize);
pub fn get_mesh_section_count(handle: MeshHandle) -> u64;
pub fn get_mesh_section_dominant_color(
handle: MeshHandle,
idx: u64,
) -> DominantColorWithArea;
pub fn get_mesh_section_material_index(handle: MeshHandle, idx: u64) -> u64;
/// Get the pairs of entities that were involved in collisions this frame.
/// Returns the number of pairs. You can use this to know how large you should allocate `out_pairs`.
/// Example:
/// ```ignore
/// let count = get_collided_entity_pairs(&mut []);
/// let mut pairs = vec![CollisionPair::zeroed(); count as usize];
/// get_collided_entity_pairs(&mut pairs);
/// ```
pub fn get_collided_entity_pairs(out_pairs: &mut [EntityPair]) -> u32;
/// Returns the number of collisions.
/// Note that not all entity pairs necessarily have a collision. There can at most be one collision per pair though.
/// Also note the the entity pairs in `out_collision` might have their order swapped compared to `entities`.
pub fn get_collision_info(
entities: &[EntityPair],
out_collisions: &mut [CollisionInfo],
) -> u32;
/// Get collisions that have happened this frame.
/// Returns the number of collisions.
pub fn get_all_collision_info(out_collisions: &mut [CollisionInfo]) -> u32;
// TODO (nises): add `get_extended_collisions` that returns more info about the collisions
/// Gets the entity pairs that stopped colliding this frame.
pub fn get_ended_collision_entity_pairs(out_pairs: &mut [EntityPair]) -> u32;
/// Get all entity pairs that have started triggering this frame.
/// Returns the number of events.
pub fn get_started_trigger_entity_pairs(out_pairs: &mut [EntityPair]) -> u32;
/// Get all entity pairs that have stopped triggering this frame.
/// Returns the number of events.
pub fn get_ended_trigger_entity_pairs(out_pairs: &mut [EntityPair]) -> u32;
}
}
pub use world::*;