Class: TModifiableImage

Declaration: GraphicImage.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TImage

Inherited By:

TA1R5G5B5Image TA8R8G8B8Image TAlpha8Gray8Image TC8M8Y8K8Image TGrayImage THalftoneImage TIndexedImage TR8G8B8Image Tb1R5G5B5Image Tb8R8G8B8Image

Purpose:

TModifiableImage provides a wrapper for TGModifiableImage, which is a geometry class representing a device-independent, pixel-based, editable image. Classes derived from TModifiableImage support various image storage formats such as continuous tone monochrome or color images, and transparent RGB images.

Instantiation:

Abstract base class; do not instantiate.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TModifiableImage::~TModifiableImage

virtual ~ TModifiableImage ()

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: TModifiableImage::GetImage

virtual const TGImage * GetImage () const

Interface Category:

API.

Purpose:

Returns an uneditable version of the image.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a const reference to the image geometry.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModifiableImage::GetGrafPort

TGrafPort * GetGrafPort ()

Interface Category:

API.

Purpose:

Returns the port used to draw into the image.

Calling Context:

Call to determine the image's graphics port.

Parameters:

Takes no parameters.

Return Value:

Returns a reference to the graphics port used to draw the image.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModifiableImage::GetModifiableImage

TGModifiableImage * GetModifiableImage () const

Interface Category:

API.

Purpose:

Returns the image geometry for which this class is a wrapper. The returned image geometry is editable.

Calling Context:

Call to get an editable version of the image.

Parameters:

Takes no parameters.

Return Value:

A reference to an editable version of the image.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModifiableImage::GetSourceBounds

virtual TGRect GetSourceBounds () const

Interface Category:

API.

Purpose:

Calculates and returns the bounding rectangle of the source image for the image object (in pixel space).

Calling Context:

Call to determine the bounds of the source image.

Parameters:

Takes no parameters.

Return Value:

Returns the smallest rectangle that fully encloses the source image.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModifiableImage::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream to which the object streams itself out.

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: TModifiableImage::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream from which the object streams itself in.

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.

Member Function: TModifiableImage::TModifiableImage

TModifiableImage ()
TModifiableImage (const TModifiableImage &)
TModifiableImage (const TImage &)
TModifiableImage (const TGrafMatrix &, TGrafBundle * adoptBundle =NIL)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Creates an editable version of a uneditable image.
Creates an editable image initialized with the specified transformation matrix and attribute bundle.

Calling Context:

Called by the stream-in operators.
Called to copy an object.
Call to create an editable version of a uneditable image.
Call to create a TModifiableImage initialized with a transformation matrix and attribute bundle.

Parameters:

Takes no parameters.
const TModifiableImage & -The image to be copied.
const TImage & -The image for which to create an editable version.
const TGrafMatrix & -The initial transformation matrix for the image. The default is the identity matrix.
TGrafBundle * adoptBundle =NIL -The initial attribute bundle for the image. The default is NIL.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TModifiableImage is an abstract base class. Do not allocate.

Member Function: TModifiableImage::operator=

TModifiableImage & operator =(const TModifiableImage & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TModifiableImage & source -The image to be copied.

Return Value:

Returns a 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: TModifiableImage::AdoptImage

void AdoptImage (TGModifiableImage * theImage)

Interface Category:

API.

Purpose:

Allows caller to change the image of a modifiable image object.

Calling Context:

Called when changing the image of a preexistent modifiable image object.

Parameters:

TGModifiableImage * theImage -The image that is to be adopted.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModifiableImage::AdoptGrafDevice

void AdoptGrafDevice (TGrafDevice * theGrafDevice)

Interface Category:

API.

Purpose:

Allows caller to change the device used by a modifiable image object.

Calling Context:

Called when changing the device of a preexistent modifiable image object.

Parameters:

TGrafDevice * theGrafDevice -The device that is to be adopted.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModifiableImage::CreateGrafDevice

virtual TGrafDevice * CreateGrafDevice ()

Interface Category:

API.

Purpose:

Creates a new rendering pipeline device for an image object.

Calling Context:

Called when no graphics device has been defined for the object.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to a new graphics device.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModifiableImage::GetSourceOrigin

virtual TGPoint GetSourceOrigin () const

Interface Category:

API.

Purpose:

Returns the defined origin for the source image of a given object.

Calling Context:

Called when the user needs to determine the origin of the source image.

Parameters:

Takes no parameters.

Return Value:

Returns the coordinate which corresponds to the location of the origin of the source image (in pixel space).

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.