## Libraries.Game.Collision.Shapes.Sphere Documentation

This class describes the sphere shape in 3D.

## Actions Documentation

### CalculateLocalInertia(number mass, Libraries.Compute.Vector3 inertia)

This action approximates the inertia of the sphere.

### CalculateTemporalBoundingBox(Libraries.Game.Collision.PhysicsPosition3D currentTransform, Libraries.Compute.Vector3 linearVelocity, Libraries.Compute.Vector3 angularVelocity, number timeStep, Libraries.Game.BoundingBox temporalBoundingBox)

This action calculates the rectangular cube that will contain both the object in its position currently and also contain the object in a position after "timeStep" seconds from now.

### Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

#### Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

``````Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
``````

### ComputeBoundingBox(Libraries.Game.BoundingBox boundingBox, Libraries.Game.Collision.PhysicsPosition3D transform)

This action finds the bounding box that would bound the Sphere in its current position.

### Copy()

This action sets another sphere to have the properties of the current sphere.

### Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

#### Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

``````use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
``````

### GetAngularMotionDisc()

This calculates the maximum distance between any point to the center of the 3D object.

number:

### GetBoundingSphere(Libraries.Compute.Vector3 center)

This action finds the center (relative to the object's local origin) and the radius of a sphere that would bound the object that is at its current position.

number:

### GetChildCount()

This action returns how many children shapes are attached to this sphere.

integer:

### GetHashCode()

This action gets the hash code for an object.

#### Return

integer: The integer hash code of the object.

Example

``````Object o
integer hash = o:GetHashCode()
``````

### GetLocalScaling(Libraries.Compute.Vector3 out)

This action returns how the 3D object has been scaled to the shape that it has right now.

### GetMargin()

This action returns the thickness of the "shell" that will surround this Sphere to prevent objects going through each other graphically.

number:

### GetNumberPreferredPenetrationDirections()

This action calculates the preferred number of directions to check if another object has penetrated this sphere.

integer:

### GetPreferredPenetrationDirection(integer index, Libraries.Compute.Vector3 penetrationVector)

This action calculates one of the directions to check if another object has penetrated this sphere. Since sphere is a special case, this action doesn't do anything.

#### Parameters

This action returns the radius of the Sphere.

number:

### GetType()

This action returns what type of 3D object the 3D object is.

integer:

### LocalGetSupportingVertex(Libraries.Compute.Vector3 vector)

This action returns the offset of the box that will bound the object to prevent objects going through each other graphically.

### LocalGetSupportingVertexWithoutMargin(Libraries.Compute.Vector3 vector)

This action finds the vertex that is furthest away in a direction specified by "Vector3 vector" that doesn't have an offset.

### Scale(Libraries.Compute.Vector3 scale)

This action sets how big the 3D object is, scaling from the current size of the 3D object.

#### Parameters

This action sets the radius of the Sphere.

### SetLocalScaling(Libraries.Compute.Vector3 scaling)

This action sets how big the 3D object is, scaling from the default size of the 3D object.

### SetMargin(number margin)

This action sets the thickness of the "shell" that will surround this Sphere to prevent objects going through each other graphically.

#### Parameters

• number margin

This action sets the radius of the Sphere.