Photon Quantum 3.0.0

Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Quantum.Shape3DConfig Class Reference

The base settings for building a Shape3D. More...

Classes

struct  CompoundShapeData3D
 The settings of each shape in the compound of shapes list. More...
 

Public Member Functions

Shape3D CreateShape (FrameBase f)
 Creates a Shape3D using the all the data set in the Shape3DConfig. More...
 

Static Public Member Functions

static bool Copy (Shape3DConfig from, Shape3DConfig to)
 Copies all the shape config values to anothere shape config. More...
 

Public Attributes

FPVector3 BoxExtents
 The vector that represents the extents of the box in each axis. More...
 
FP CapsuleExtent => (CapsuleHeight / FP._2) - CapsuleRadius
 The capsule extent is the distance from the center of the capsule to some of the spheres' centers. More...
 
FP CapsuleHeight
 The size of the capsule from the top end to the bottom end. More...
 
FP CapsuleRadius
 The radius of the capsule. More...
 
CompoundShapeData3D[] CompoundShapes
 The configuration array of each shape in the compound that will be allocated. More...
 
Boolean IsPersistent = true
 Means the buffer of shapes is allocated in the memory. It will be free when the component is removed from the entity. More...
 
FPVector3 PositionOffset
 The position offset of the shape. More...
 
FPVector3 RotationOffset
 The rotation offset of the shape. More...
 
Shape3DType ShapeType
 The type of the shape. More...
 
FP SphereRadius
 The radius of the sphere. More...
 
UInt16 UserTag
 The user tag to identify the compound shape during the collision event. More...
 

Detailed Description

The base settings for building a Shape3D.

Member Function Documentation

◆ CreateShape()

Shape3D Quantum.Shape3DConfig.CreateShape ( FrameBase  f)
inline

Creates a Shape3D using the all the data set in the Shape3DConfig.

Parameters
fThe current frame.

◆ Copy()

static bool Quantum.Shape3DConfig.Copy ( Shape3DConfig  from,
Shape3DConfig  to 
)
inlinestatic

Copies all the shape config values to anothere shape config.

Parameters
fromThe shape config that will be copied.
toThe shape config that will receive the other values.
Returns
Returns true if the first argument is different from null.

Member Data Documentation

◆ ShapeType

Shape3DType Quantum.Shape3DConfig.ShapeType

The type of the shape.

◆ SphereRadius

FP Quantum.Shape3DConfig.SphereRadius

The radius of the sphere.

◆ CapsuleRadius

FP Quantum.Shape3DConfig.CapsuleRadius

The radius of the capsule.

◆ CapsuleHeight

FP Quantum.Shape3DConfig.CapsuleHeight

The size of the capsule from the top end to the bottom end.

◆ CapsuleExtent

FP Quantum.Shape3DConfig.CapsuleExtent => (CapsuleHeight / FP._2) - CapsuleRadius

The capsule extent is the distance from the center of the capsule to some of the spheres' centers.

◆ PositionOffset

FPVector3 Quantum.Shape3DConfig.PositionOffset

The position offset of the shape.

◆ BoxExtents

FPVector3 Quantum.Shape3DConfig.BoxExtents

The vector that represents the extents of the box in each axis.

◆ RotationOffset

FPVector3 Quantum.Shape3DConfig.RotationOffset

The rotation offset of the shape.

◆ UserTag

UInt16 Quantum.Shape3DConfig.UserTag

The user tag to identify the compound shape during the collision event.

◆ IsPersistent

Boolean Quantum.Shape3DConfig.IsPersistent = true

Means the buffer of shapes is allocated in the memory. It will be free when the component is removed from the entity.

Only persistent compound shapes are supported on the editor.

◆ CompoundShapes

CompoundShapeData3D [] Quantum.Shape3DConfig.CompoundShapes

The configuration array of each shape in the compound that will be allocated.