Class: TSphere3D

Declaration: Sweep3D.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MGraphic3D

Inherited By:

None.

Purpose:

TSphere3D is a concrete class derived from MGraphic3D that represents a spherical surface. Member functions are provided to set and get the radius. In addition, all the standard MGraphic3D member functions are implemented (Draw, GetGeometricBounds, TransformBy, and so on). A sphere can also be generated by using TSweep3D, but such an object can easily be altered beyond recognition. If you need to manipulate the sphere in ways not provided by the TSphere3D member functions, you can invoke TSphere3D::CreateSweepSurface to access a TSweep3D with the same geometry and attributes as the TSphere3D.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSphere3D::TSphere3D

TSphere3D ()
TSphere3D (GCoordinate radius, TGrafBundle3D * adoptBundle =NIL)
TSphere3D (const TSphere3D & copy)

Interface Category:

API.

Purpose:

Default constructor.
Creates a TSphere3D from the specified radius and adopts the attribute bundle.
Copy constructor.

Calling Context:

Called by the stream-in operators and directly.
Call this function directly.
Called to copy an object.

Parameters:

Takes no parameters.
GCoordinate radius -The radius of the new sphere.
TGrafBundle3D * adoptBundle =NIL -The attribute bundle to be adopted.
const TSphere3D & copy -The sphere to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSphere3D::~TSphere3D

virtual ~ TSphere3D ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSphere3D::Draw

virtual void Draw (TGrafPort & port) const

Interface Category:

API.

Purpose:

Draws this TSphere3D to the specific TGrafPort. Attributes in the graphic's bundle override those already provided in the port (if any).

Calling Context:

Call this function directly.

Parameters:

TGrafPort & port -The port to which drawing should go. The port in turn invokes rendering on a particular TGrafDevice.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSphere3D::GetGeometricBounds

virtual TGBox3D GetGeometricBounds () const

Interface Category:

API.

Purpose:

Returns this TSphere3D's bounding box, without considering any volume added by its bundle.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the bounding box of the sphere's geometry.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSphere3D::TransformBy

virtual void TransformBy (const TGrafMatrix3D & matrix)

Interface Category:

API.

Purpose:

Transforms this TSphere3D's shape and position by applying the specified transformation matrix.

Calling Context:

Call this function directly.

Parameters:

const TGrafMatrix3D & matrix -The transformation matrix by which the graphic's points are multiplied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSphere3D::SetRadius

virtual void SetRadius (GCoordinate baseRadius)

Interface Category:

API.

Purpose:

Sets this TSphere3D's radius to the specified value.

Calling Context:

Call this function directly.

Parameters:

GCoordinate baseRadius -The new value for the sphere's radius.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSphere3D::GetRadius

virtual GCoordinate GetRadius () const

Interface Category:

API.

Purpose:

Gets this TSphere3D's radius.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the sphere's radius.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSphere3D::CreateSweepSurface

virtual TSweep3D * CreateSweepSurface () const

Interface Category:

API.

Purpose:

Creates and returns a TSweep3D from this TSphere3D. This allows you to manipulate the cone in ways not permitted by its member functions.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a sweep that corresponds to the sphere.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSphere3D::operator=

TSphere3D & operator =(const TSphere3D & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSphere3D & source -The sphere to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSphere3D::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & towhere -The stream that the object is streamed out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSphere3D::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -The stream that the object is streamed in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.