Module content.scripts.construction.collider_util_serialized🔗

 
global record ColliderUtilSerialized  
record Collider    
enum Type      "BOX"
      "CYLINDER"
      "NONE"
      "POINT_CLOUD"
end

    
record Params      halfExtents: Vec3Serialized.Table3
      points: {Vec3Serialized.Table3}
end

    type: Type
    transf: Mat4Serialized.Mat4
    params: Params
end

  
enum Direction    "X"
    "Y"
end

  createBox: function(center : Vec3Serialized.Vec3, halfExtents : Vec3Serialized.Vec3): Collider
  createCylinder: function(direction : ColliderUtilSerialized.Direction, center : Vec3Serialized.Vec3, halfExtents : Vec3Serialized.Vec3): Collider
  createPointCloud: function(points : {Vec3Serialized.Vec3}): Collider
  extrudePoints: function(points : {Vec3Serialized.Vec3}, offset1 : number, offset2 : number): {Vec3Serialized.Vec3}
end

Category: globals🔗

ColliderUtilSerialized🔗

 
global record ColliderUtilSerialized  
record Collider    
enum Type      "BOX"
      "CYLINDER"
      "NONE"
      "POINT_CLOUD"
end

    
record Params      halfExtents: Vec3Serialized.Table3
      points: {Vec3Serialized.Table3}
end

    type: Type
    transf: Mat4Serialized.Mat4
    params: Params
end

  
enum Direction    "X"
    "Y"
end

  createBox: function(center : Vec3Serialized.Vec3, halfExtents : Vec3Serialized.Vec3): Collider
  createCylinder: function(direction : ColliderUtilSerialized.Direction, center : Vec3Serialized.Vec3, halfExtents : Vec3Serialized.Vec3): Collider
  createPointCloud: function(points : {Vec3Serialized.Vec3}): Collider
  extrudePoints: function(points : {Vec3Serialized.Vec3}, offset1 : number, offset2 : number): {Vec3Serialized.Vec3}
end

ColliderUtilSerialized.Collider🔗

 
record ColliderUtilSerialized.Collider  
enum Type    "BOX"
    "CYLINDER"
    "NONE"
    "POINT_CLOUD"
end

  
record Params    halfExtents: Vec3Serialized.Table3
    points: {Vec3Serialized.Table3}
end

  type: Type
  transf: Mat4Serialized.Mat4
  params: Params
end

ColliderUtilSerialized.Collider.Type🔗

enum ColliderUtilSerialized.Collider.Type  "BOX"
  "CYLINDER"
  "NONE"
  "POINT_CLOUD"
end

ColliderUtilSerialized.Collider.Type."BOX"🔗

Box-shaped collider

ColliderUtilSerialized.Collider.Type."CYLINDER"🔗

Cylinder-shaped collider

ColliderUtilSerialized.Collider.Type."NONE"🔗

No collider shape

ColliderUtilSerialized.Collider.Type."POINT_CLOUD"🔗

Point cloud collider

ColliderUtilSerialized.Collider.Params🔗

record ColliderUtilSerialized.Collider.Params  halfExtents: Vec3Serialized.Table3
  points: {Vec3Serialized.Table3}
end

ColliderUtilSerialized.Collider.Params.halfExtents🔗

ColliderUtilSerialized.Collider.Params.halfExtents: Vec3Serialized.Table3

Half-extents of the box or cylinder (x, y, z)

ColliderUtilSerialized.Collider.Params.points🔗

ColliderUtilSerialized.Collider.Params.points: {Vec3Serialized.Table3}

Points used for a point cloud collider

ColliderUtilSerialized.Collider.type🔗

ColliderUtilSerialized.Collider.type: Type

ColliderUtilSerialized.Collider.transf🔗

ColliderUtilSerialized.Collider.transf: Mat4Serialized.Mat4

Transform matrix of collider

ColliderUtilSerialized.Collider.params🔗

ColliderUtilSerialized.Collider.params: Params

Shape parameters of collider

ColliderUtilSerialized.Direction🔗

enum ColliderUtilSerialized.Direction  "X"
  "Y"
end

ColliderUtilSerialized.Direction."X"🔗

Along the X axis

ColliderUtilSerialized.Direction."Y"🔗

Along the Y axis

ColliderUtilSerialized.createBox🔗

function ColliderUtilSerialized.createBox(center : Vec3Serialized.Vec3, halfExtents : Vec3Serialized.Vec3): Collider

Create a box collider.

Parameters
  • center :Vec3Serialized.Vec3 — center position of the box
  • halfExtents :Vec3Serialized.Vec3 — half-extents along each axis
Returns
  1. Collider — box collider

ColliderUtilSerialized.createCylinder🔗

function ColliderUtilSerialized.createCylinder(direction : ColliderUtilSerialized.Direction, center : Vec3Serialized.Vec3, halfExtents : Vec3Serialized.Vec3): Collider

Create a cylinder collider.

Parameters
  • direction :ColliderUtilSerialized.Direction — axis direction of the cylinder, default (nil) is z-direction
  • center :Vec3Serialized.Vec3 — center position of the cylinder, default (nil) is origin
  • halfExtents :Vec3Serialized.Vec3 — half-extents along each axis, default (nil) is none
Returns
  1. Collider — cylinder collider

ColliderUtilSerialized.createPointCloud🔗

function ColliderUtilSerialized.createPointCloud(points : {Vec3Serialized.Vec3}): Collider

Create a point cloud collider.

Parameters
  • points :{Vec3Serialized.Vec3} — list of points forming the cloud
Returns
  1. Collider — point cloud collider

ColliderUtilSerialized.extrudePoints🔗

function ColliderUtilSerialized.extrudePoints(points : {Vec3Serialized.Vec3}, offset1 : number, offset2 : number): {Vec3Serialized.Vec3}

Extrude a list of points by offsetting them along the z-direction. Each point is hence added twice once with offset1 and once with offset2.

Parameters
  • points :{Vec3Serialized.Vec3} — input points to extrude
  • offset1 :number — offset for first set of extruded points
  • offset2 :number — offset for second set of extruded points
Returns
  1. {Vec3Serialized.Vec3} — extruded point list