This version of documentation is OUTDATED! Please switch to the latest one.

Unigine::WorldBoundSphere Class

This class serves to construct the bounding sphere in double precision coordinates.

By using this class you can easily find the common bounding sphere for several objects by expanding the bounding sphere.

static WorldBoundSpherePtr create ( ) #

Constructor. Creates an empty bounding sphere.

WorldBoundSphere ( Math::Vec3 & center, Math::Scalar radius ) #

Constructor. Initializes bounding sphere by the center and radius of the bounding sphere.

Arguments

• Math::Vec3 & center - The bounding sphere center.

WorldBoundSphere ( const WorldBoundSphere & bs ) #

Constructor. Initializes by given bounding sphere.

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

WorldBoundSphere ( const WorldBoundBox & bb ) #

Constructor. Initializes by given bounding box.

WorldBoundSphere ( const BoundSphere & bs, const Math::Mat4 & transform ) #

Initialization by the bounding sphere and setting the given transformation matrix to the new bounding sphere.

Arguments

• const BoundSphere & bs - The bounding sphere.
• const Math::Mat4 & transform - Transformation matrix.

WorldBoundSphere &operator= ( const WorldBoundSphere & bs ) #

Assignment operator for the bounding sphere.

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

voidclear ( ) #

Clears the bounding sphere.

voidset ( const Math::Vec3 & center, Math::Scalar radius ) #

Sets the bounding sphere by its center and radius.

Arguments

• const Math::Vec3 & center - The bounding sphere center.

voidset ( const WorldBoundSphere & bs ) #

Sets the bounding sphere.

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

voidset ( const WorldBoundBox & bb ) #

Sets the bounding sphere by the bounding box.

voidset ( const BoundSphere & bs, const Math::Mat4 & transform ) #

Sets the bounding sphere by a bounding sphere with a transformation matrix taken into account.

Arguments

• const BoundSphere & bs - The bounding sphere.
• const Math::Mat4 & transform - Transformation matrix.

voidexpand ( const Math::Vec3 & point ) #

Expands the current bounding sphere for including given point.

Arguments

• const Math::Vec3 & point - Point coordinates.

voidexpand ( const WorldBoundSphere & bs ) #

Expands the current bounding sphere for including given bounding sphere.

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

voidexpand ( const WorldBoundBox & bb ) #

Expands the current bounding sphere for including given bounding box.

intinside ( const Math::Vec3 & point ) const#

Checks if the given point is inside the current bounding sphere.

Arguments

• const Math::Vec3 & point - Point coordinates.

Return value

1 if the given point is inside the bounding sphere; otherwise, 0.

intinside ( const Math::Vec3 & point, Math::Scalar radius ) const#

Checks if the sphere is inside the bounding sphere.

Arguments

• const Math::Vec3 & point - The coordinates of the center of the sphere .

Return value

1 if the sphere is inside the bounding sphere; otherwise, 0.

intinside ( const Math::Vec3 & min, const Math::Vec3 & max ) const#

Checks if the box is inside the bounding sphere.

Arguments

• const Math::Vec3 & min - The box minimum coordinates.
• const Math::Vec3 & max - The box maximum coordinates.

Return value

1 if the box is inside the bounding sphere; otherwise, 0.

intinside ( const WorldBoundSphere & bs ) const#

Checks if the specified bounding sphere is inside the current bounding sphere.

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

Return value

1 if the specified bounding sphere is inside the current bounding sphere; otherwise, 0.

intinside ( const WorldBoundBox & bb ) const#

Checks if the bounding box is inside the bounding sphere.

Return value

1 if the bounding box is inside the bounding sphere; otherwise, 0.

intinsideValid ( const Math::Vec3 & point ) const#

Checks if the given point is inside the current bounding sphere.
Notice
The method doesn't check if the bounding sphere is valid (has a positive radius).

Arguments

• const Math::Vec3 & point - Point.

Return value

1 if the given point is inside the bounding sphere; otherwise, 0.

intinsideValid ( const Math::Vec3 & point, Math::Scalar radius ) const#

Checks if the given sphere is inside the current bounding sphere.
Notice
The method doesn't check if the bounding sphere is valid (has a positive radius).

Arguments

• const Math::Vec3 & point - Cente of the sphere.

Return value

1 if the sphere is inside the bounding sphere; otherwise, 0.

intinsideValid ( const Math::Vec3 & min, const Math::Vec3 & max ) const#

Checks if the box is inside the bounding sphere.
Notice
The method doesn't check if the bounding sphere is valid (has a positive radius).

Arguments

• const Math::Vec3 & min - The box minimum coordinates.
• const Math::Vec3 & max - The box maximum coordinates.

Return value

1 if the box is inside the bounding sphere; otherwise, 0.

intinsideValid ( const WorldBoundSphere & bs ) const#

Checks if the bounding sphere is inside the bounding sphere.
Notice
The method doesn't check if the bounding sphere is valid (has a positive radius).

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

Return value

1 if the bounding sphere is inside the bounding sphere; otherwise, 0.

intinsideValid ( const WorldBoundBox & bb ) const#

Checks if the bounding box is inside the bounding sphere.
Notice
The method doesn't check if the bounding sphere is valid (has a positive radius).

Return value

1 if the bounding box is inside the bounding sphere; otherwise, 0.

intinsideAll ( const WorldBoundSphere & bs ) const#

Checks if the whole specified bounding sphere is inside the current bounding sphere.

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

Return value

1 if the whole specified sphere is inside the current bounding sphere; otherwise, 0.

intinsideAll ( const WorldBoundBox & bb ) const#

Checks if the whole bounding box is inside the bounding sphere.

Return value

1 if the whole box is inside the bounding sphere; otherwise, 0.

intinsideAllValid ( const WorldBoundSphere & bs ) const#

Checks if the whole given bounding sphere is inside the current bounding sphere.
Notice
The method doesn't check if the bounding sphere is valid (has a positive radius).

Arguments

• const WorldBoundSphere & bs - Bounding sphere.

Return value

1 if the whole bounding sphere is inside the bounding sphere; otherwise, 0.

intinsideAllValid ( const WorldBoundBox & bb ) const#

Checks if the whole given bounding box is inside the current bounding sphere.
Notice
The method doesn't check if the bounding sphere is valid (has a positive radius).

Return value

1 if the whole bounding box is inside the bounding sphere; otherwise, 0.

Math::ScalardistanceValid ( const Math::Vec3 & point ) const#

Returns the distance from the given point to the closest point of the current bounding sphere.

Arguments

• const Math::Vec3 & point - Point

Return value

Distance from the point, in units.

boolisValid ( ) const#

Checks the bounding sphere status.

Return value

1 if the bounding sphere radius has a positive value.

Math::Vec3getCenter ( ) const#

Gets the bounding sphere center.

Return value

The bounding sphere center.