class Image
{
public:
friend class Internal;
/// <summary>
///
The empty
or "NULL" construct
or f
or an <c>Atil::Image</c>
.
/// </summary>
///
/// <remarks>
/// An instance of an image created through this construct
or is intended only to facilitate
///
the later assignment of a valid image
. The instance created through this construct
or has
///
no internal data
that can be returned
. Attempting access any data
from a "NULL" image will
/// result in an exception
.
/// </remarks>
Image ();
/// <summary>
///
The clone construct
or of
the Image class allows
the construction of a new instance based
/// on an existing instance
.
/// </summary>
///
/// <param name= 'image'>
/// A const reference to
the image to
be copied
.
/// </param>
///
/// <exception cref="ImageConstructionException">Thrown when
the image
can
///
not
be cloned <see cref="ImageConstructionException"/>
.
/// </exception>
///
/// <remarks>
/// ATIL implements
the Image class with a "letter - envelope"
or "Bridge"
/// design pattern
. See "Design Patterns, ISBN 0-201-63361-2"
.
/// </remarks>
///
Image (const Image & image);
/// <summary>
///
The blank image construct
or f
or an <c>Image</c>
.
/// </summary>
///
/// <param name='size'>
The size of
the image to
be created
.</param>
///
/// <param name='col
orspace'>
The DataModel of
the image to
be created
.</param>
///
/// <param name='initialCol
or'>
The clear col
or of
the image data
.</param>
///
/// <param name='sz'>
The tile size to use f
or the image
.
///
The default, <c>DataModel::TileSize::kUnspecified</c> is recommended
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will
be thrown
/// if
the image
can not
be constructed
. <see cref="ImageConstructionException"/>
.
/// </exception>
///
Image (const Size& size, const DataModel* col
orspace, ImagePixel initialCol
or,
DataModel::TileSize sz = DataModel::kUnspecified);
/// <summary>
///
The user supplied buffer construct
or f
or <c>Atil::Image</c>
. This method of construction
/// will wrap a user supplied buffer with
the Image object allowing ATIL and
the using
/// application mutual access to
the image data
. Images created in this way
are not mem
ory managed
.
/// </summary>
///
/// <param name='pData'>A pointer to
the buffer
that the image should use f
or its image
/// data st
orage
.
/// </param>
///
/// <param name='nBytesInBuffer'>An integer
that descri
bes
the num
ber of bytes
///
that have
been allocated in
the <c>pData</c> parameter
.
/// </param>
///
/// <param name='nBytesPerRow'>An integer
that descri
bes
the num
ber of bytes in
/// one row of
the data
. This sometimes referred to as
the stride of
the data
.
///
The num
ber of bytes
from the beginning of one row to
the beginning of
the next row
.
/// </param>
///
/// <param name='size'>
The h
orizontal and vertical dimensions of
the image
.
///
The buffer in pData must
be large e
nough to hold
these dimensions
.
/// </param>
///
/// <param name='pDm'>A constant pointer to a <c>DataModel</c> instance
that
/// represents
the data
that will
be contained in
the image
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will
be thrown
/// if
the image
can not
be constructed
. <see cref="ImageConstructionException"/>
.
/// </exception>
///
Image (void* pData, int nBytesInBuffer, int nBytesPerRow, const Size& size, const DataModel* pDm);
/// <summary>
/// A <c>RowProviderInterface</c> based construct
or f
or Image
.
/// </summary>
///
/// <param name='pPipe'>A source of image data
.
/// </param>
///
/// <param name='sz'>
The tile size to
be used f
or the image
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will
be thrown
/// if
the image
can not
be constructed
. <see cref="ImageConstructionException"/>
.
/// </exception>
///
/// <remarks>
/// This method will "consume"
the <c>RowProviderInterface</c> and free
the resources
///
that it holds
. The <c>RowProviderInterface</c> is
no longer valid after using
/// it in this method
.
/// </remarks>
///
Image (RowProviderInterface* pPipe,
DataModel::TileSize sz = DataModel::kUnspecified);
/// <summary>
/// A <c>RowProviderInterface</c> based construct
or f
or Image with
the option
.
/// to re
orient
the input
.
/// </summary>
///
/// <param name='pPipe'>A source of image data
.
/// </param>
///
/// <param name='
orient'>
The orientation to apply to
the image when st
oring
///
the data in
the image
.
/// </param>
///
/// <param name='sz'>
The tile size to
be used f
or the image
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will
be thrown
/// if
the image
can not
be constructed
. <see cref="ImageConstructionException"/>
.
/// </exception>
///
Image (RowProviderInterface* pPipe, Atil::
Orientation
orient,
DataModel::TileSize sz = DataModel::kUnspecified);
/// <summary>
///
The <c>FileReadDescript
or</c> based construct
or f
or Image
. This is
the construct
or
/// to use when you want to load an image
from a file
.
/// </summary>
///
/// <param name='readDesc'>
The <c>FileReadDescript
or</c> source of image data
.
/// </param>
///
/// <param name='sz'>
The tile size to
be used f
or the image
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will
be thrown
/// if
the image
can not
be constructed
. <see cref="ImageConstructionException"/>
.
/// </exception>
///
/// <remarks>
///
The image will
be constructed
from the current frame set in
the FileReadDescript
or.
/// </remarks>
///
Image (FileReadDescript
or& readDesc,
DataModel::TileSize sz = DataModel::kUnspecified);
/// <summary>
///
The destruct
or will release all image
resources with
the exception of
/// user allocated buffers
.
/// </summary>
///
~Image ();
/// <summary>
///
The assignment operat
or will destroy
the existing image data and make a reference
/// to
the assigned image data
.
/// </summary>
///
/// <param name= 'image'>
/// A const reference to
the image to
be assigned to <c>*this</c>
.
/// </param>
///
/// <returns>
/// This returns a reference to <c>*this</c>
.
/// </returns>
///
const Image& operat
or= (const Image& image);
/// <summary>
///
The assignment operat
or will destroy
the existing image data and construct a new
/// image
from the result of
the <c>RowProviderInterface</c>
.
/// </summary>
///
/// <param name="pPipe">An instance of a <c>RowProviderInterface</c>
that will supply
///
the pixel data to
be drawn
. The <c>RowProviderInterface</c> is consumed and freed
.
/// </param>
///
/// <returns>
/// This returns a reference to <c>*this</c>
.
/// </returns>
///
/// <remarks>
/// This method will "consume"
the <c>RowProviderInterface</c> and free
the resources
///
that it holds
. The <c>RowProviderInterface</c> is
no longer valid after using
/// it in this method
.
/// </remarks>
///
const Image& operat
or= (RowProviderInterface* pPipe);
/// <summary>
///
The equals operat
or.
/// </summary>
///
/// <param name= 'image'>
/// A const reference to
the image to
be comp
ared
.
/// </param>
///
/// <returns>
/// This will return true of both objects refer to
the same data
.
/// </returns>
///
/// <remarks>
/// While this method is provided it is
not considered a reliable method f
or
/// testing equality
.
/// </remarks>
///
bool operat
or== (const Image& image) const;
/// <summary>
///
The not equals operat
or.
/// </summary>
///
/// <param name= 'image'>
/// A const reference to
the image to
be comp
ared
.
/// </param>
///
/// <returns>
/// This will return true of both objects do
not refer to
the same data
.
/// </returns>
///
/// <remarks>
/// While this method is provided it is
not considered a reliable method f
or
/// testing equality
.
/// </remarks>
///
bool operat
or!= (const Image& image) const;
/// <summary>
/// This returns
the size of
the image in pixels
.
/// </summary>
///
/// <returns>
/// This returns a const reference to a <c>Size</c> object
.
/// </returns>
///
const Size& size () const;
/// <summary>
/// This returns
the size of a tile of
the image in pixels
.
/// </summary>
///
/// <returns>
/// This returns a <c>Size</c> object
.
/// </returns>
///
Size tileSize () const;
/// <summary>
/// This method returns a const reference to
the images dataModel
. It is useful
/// f
or testing
the qualities of an image
. All images have a dataModel
.
/// </summary>
///
/// <returns>
/// This returns a const reference to
the <c>DataModel</c> f
or the image
.
/// </returns>
///
const DataModel& dataModel () const;
/// <summary>
/// This method will return
the <c>FileReadDescript
or</c> used to create
the image
/// if
the image was created with a <c>FileReadDescript
or</c>
. The return will
be
/// NULL o
therwise
.
/// </summary>
///
/// <returns>
/// This returns a const pointer to
the <c>FileReadDescript
or</c> if one was used
/// to construct
the image and NULL if
not
.
/// </returns>
///
const FileReadDescript
or* fileReadDescript
or () const;
/// <summary>
/// This method will return
the num
ber of tiles in
the image
. There is always
/// at least one tile in a valid image
.
/// </summary>
///
/// <param name="nRows">A integer reference which will
be set to
the num
ber of
/// tiles used to hold a row of
the image
.
/// </param>
///
/// <param name="nColumns">A integer reference which will
be set to
the num
ber of
/// tiles used to hold a column of
the image
.
/// </param>
///
/// <returns>
/// This returns
the num
ber of tiles in
the image
.
/// </returns>
///
int numTiles (int& nRows, int& nColumns) const;
/// <summary>
/// This method returns
the clear col
or of
the image
.
/// </summary>
///
/// <returns>
/// This returns a const reference to th <c>ImagePixel</c>
that holds
the clear col
or.
/// </returns>
///
const ImagePixel& clearCol
or () const;
/// <summary>
/// A new data model may
be set onto an image through this method
. The datamodel
being
/// set must
be compatible with
the num
ber of bands and band width of
the image data
.
/// </summary>
///
/// <param name='dataModel'>A constant reference to a <c>DataModel</c> instance
that
/// will
be used as
the representation of
the data
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will
be thrown
/// if
the data type of
the image is incompatible with
the data model instance
being set
/// <see cref="ImageConstructionException"/>
.
/// </exception>
///
void setDataModel ( const DataModel& dataModel );
/// <summary>
/// This method will set
the Image's clear col
or.
/// </summary>
///
/// <param name="value">An <c>ImagePixel</c>
that holds
the col
or to
be
/// used as
the clear col
or.
/// </param>
///
/// <exception cref="ImageException">An exception will
be thrown if
the pixel type of
the
/// parameter is incompatible with
the data model image <see cref="ImageException"/>
.
/// </exception>
///
/// <remarks>
///
The clear col
or is
the col
or that will
be return f
or any pixel which is
not
/// set with a value by
the constructed image
.
/// </remarks>
///
void setClearCol
or ( ImagePixel value );
/// <summary>
/// Use this method to draw pixels
from the <c>RowProviderInterface</c> into
the image
/// at
the specified location
.
/// </summary>
///
/// <param name="pPipe">An instance of a <c>RowProviderInterface</c>
that will supply
///
the pixel data to
be drawn
. The <c>RowProviderInterface</c> is consumed and freed
.
/// </param>
///
/// <param name="at">
The offset, in pixels, to
the upper left c
orner at which
the
/// first pixel of
the first row
from the <c>RowProviderInterface</c> will
be drawn
.
/// </param>
///
/// <param name="bRespectTransp
arency">A defaulted(false) boolean
that if true will
/// cause pixels
that have an alpha of 0
not to
be drawn
.
/// </param>
///
/// <remarks>
/// This method will "consume"
the <c>RowProviderInterface</c> and free
the resources
///
that it holds
. The <c>RowProviderInterface</c> is
no longer valid after using
/// it in this method
.
/// </remarks>
///
void paste (RowProviderInterface* pPipe, const Offset& at, bool bRespectTransp
arency = false);
/// <summary>
/// Use this method to draw pixels into an image
from the passed in <c>RowProviderInterface</c>
/// drawing
the data with
the specified alpha value
.
/// </summary>
///
/// <param name="pPipe">An instance of a <c>RowProviderInterface</c>
that will supply
///
the pixel data to
be drawn
. The <c>RowProviderInterface</c> is consumed and freed
.
/// </param>
///
/// <param name="at">
The offset, in pixels, to
the upper left c
orner at which
the
/// first pixel of
the first row
from the <c>RowProviderInterface</c> will
be drawn
.
/// </param>
///
/// <param name="nAlphaValue">
The input alpha range should vary
between 1 and 254
.
/// </param>
///
/// <param name="bRespectTransp
arency">A defaulted(false) boolean
that if true will
/// cause pixels
that have an alpha of 0
not to
be drawn
.
/// </param>
///
/// <exception cref="ImageException">An exception will
be thrown if
the image does
///
not have a RGB data model <see cref="ImageException"/>
.
/// </exception>
///
/// <remarks>
/// This w
orks like
the <c>paste()</c> method except
that it alpha blends
the
/// input rows into
the image
.
/// Like <c>paste()</c> it will "consume"
the <c>RowProviderInterface</c> and
/// free
the resources that it holds
. The <c>RowProviderInterface</c> is
no longer
/// valid after using it in this method
.
/// </remarks>
///
void blend (RowProviderInterface* pPipe, const Offset& at, int nAlphaValue
, bool bRespectTransp
arency = false);
/// <summary>
/// This will read a sub-rectangle of data
from the image returning it in a
/// <c>RowProviderInterface</c> instance
.
/// </summary>
///
/// <param name="size">
The size of
the sub-region of
the image to
be read which may
///
be up to
the full size of
the image
.
/// </param>
///
/// <param name="offset">
The pixel offset
from the upper left c
orner of
the image
/// to
begin reading
the requested <c>size</c> region
.
/// </param>
///
/// <returns>
/// An instance of a <c>RowProviderInterface</c>
that will supply
the data within
///
the requested region
.
/// </returns>
///
/// <remarks>
///
The requested sub-region must
be within
the bounds of
the image
.
/// </remarks>
///
RowProviderInterface* read (const Size& size, const Offset& offset) const;
//
Orientation is an enum containing
the 8 different read
orientations
.
/// <summary>
/// This will read a sub-rectangle of data
from the image returning it in a
/// <c>RowProviderInterface</c> instance
. The data
from the image will
be
/// re-
oriented
from TopDownLeftRight (
normal progression) to
the orientation
/// passed in
.
/// </summary>
///
/// <param name="size">
The size of
the sub-region of
the image to
be read which may
///
be up to
the full size of
the image
.
/// </param>
///
/// <param name="offset">
The pixel offset
from the upper left c
orner of
the image
/// to
begin reading
the requested <c>size</c> region
.
/// </param>
///
/// <param name="
orient">
The orientation to
be applied to
the data
bef
ore it is
/// returned
.
/// </param>
///
/// <returns>
/// An instance of a <c>RowProviderInterface</c>
that will supply
the data within
///
the requested region
.
/// </returns>
///
/// <remarks>
///
The requested sub-region must
be within
the bounds of
the image
.
/// </remarks>
///
RowProviderInterface* read (const Size& size, const Offset& offset,
Atil::
Orientation
orient) const;
/// <summary>
/// This method constructs an <c>ImageContext</c> <see cref="ImageContext"/>
that
/// may
be used to access
the pixels of an image directly
.
/// </summary>
///
/// <param name="accessNeeded">An <c>ImageContext</c>
can be opened f
or ei
ther
/// kRead
or kWrite access
. ImageContexts opened with kWrite do
not cache (internally)
/// as aggressively as those opened with kRead
.
/// </param>
///
/// <param name="numTilesToCache">
The num
ber of tiles to cache internal to
the
/// <c>ImageContext</c>
. The default of 4 should
be sufficient f
or most usages
.
/// </param>
///
/// <returns>
/// This will return ei
ther a pointer to a valid <c>ImageContext</c><see cref="ImageContext"/>
///
or NULL if
the method fails
. The returned object must
be freed when
the caller
/// is finished with it
.
/// </returns>
///
/// <remarks>
/// An <c>ImageContext</c> holds tiles while it exists
. They should
be delete'd when
///
not in use to free
the resources that it holds
.
/// </remarks>
///
ImageContext* createContext (ImageContext::Access accessNeeded, int numTilesToCache = 4 );
/// <summary>
/// This method constructs an <c>ImageContext</c> <see cref="ImageContext"/>
that
/// may
be used to access
the pixels of an image directly
.
/// </summary>
///
/// <param name="accessNeeded">An <c>ImageContext</c>
can be opened f
or ei
ther
/// kRead
or kWrite access
. ImageContexts opened with kWrite do
not cache (internally)
/// as aggressively as those opened with kRead
.
/// </param>
///
/// <param name="size">
The size of
the sub-region of
the image to
be accessed by
the
/// context
.
/// </param>
///
/// <param name="offset">
The pixel offset
from the upper left c
orner of
the image
/// of
the requested <c>size</c> region
.
/// </param>
///
/// <param name="numTilesToCache">
The num
ber of tiles to cache internal to
the
/// <c>ImageContext</c>
. The default of 4 should
be sufficient f
or most usages
.
/// </param>
///
/// <returns>
/// This will return ei
ther a pointer to a valid <c>ImageContext</c><see cref="ImageContext"/>
///
or NULL if
the method fails
. The returned object must
be freed when
the caller
/// is finished with it
.
/// </returns>
///
/// <remarks>
/// An <c>ImageContext</c> holds tiles while it exists
. They should
be delete'd when
///
not in use to free
the resources that it holds
.
/// </remarks>
///
ImageContext* createContext (ImageContext::Access accessNeeded,
const Size& size, const Offset& offset, int numTilesToCache = 4 );
/// <summary>
/// Adds a react
or that will call
the owner whenever a tile is saved
.
/// When a tile is saved, it is assumed to have
been edited (written to)
.
/// </summary>
///
/// <param name="pReact
or">An instance of a react
or to
be added to
the image
.
/// </param>
///
/// <remarks>
///
The <c>ImageReact
orInterface</c><see cref="ImageReact
orInterface"/>
///
can be derived
from to track changes in
the image
.
/// </remarks>
///
void addReact
or ( ImageReact
orInterface* pReact
or );
/// <summary>
/// Removes
the react
or that had previously
been
added to
the image
.
/// </summary>
///
/// <param name="pReact
or">
The instance of a react
or to
be removed from the image
.
/// </param>
///
void removeReact
or ( ImageReact
orInterface* pReact
or );
/// <summary>
/// This method disables per tile locking
. ATIL implements per tile locking f
or
/// read and write
. This option is provided as an optimization f
or instances in
/// which a developer
can guarantee single-threaded usage
. Use it c
arefully
.
/// </summary>
///
/// <param name= 'bDisable'>
///
The boolean will disable per tile locking if set to true
.
/// </param>
///
/// <returns>
/// This will return true if per tile locking is disabled
.
/// </returns>
///
bool disablePerTileLocking ( bool bDisable );
/// <summary>
/// This method will cause all pixels of
the image to
be set to
the image's
/// internal clear col
or.
/// </summary>
///
void clear ();
/// <summary>
/// This method will return true if
there is valid data within
the image
.
/// </summary>
///
/// <returns>
/// This will return true if
the image is valid
.
/// </returns>
///
bool isValid () const;
/// <summary>
/// This method will
be set to true if data has
been set into
the image
/// after construction
. There is
no way to reset it
.
/// </summary>
///
/// <returns>
/// This will return true if
the image has
been written to
.
/// </returns>
///
bool isModified () const;
/// <summary>
/// This method will return true if
the "user buffer" method of construction
/// was used to create
the image
.
/// </summary>
///
/// <returns>
/// This will return true if a "user buffer" was use to construct
the image
.
/// </returns>
///
bool usesUserBuffer () const;
/// <summary>
/// This method will return a pointer to
the "user buffer" used to construct
///
the image
.
/// </summary>
///
/// <returns>
/// This will return
the "user buffer" pointer used to construct
the image
.
/// </returns>
void* getUserBuffer ();
private:
ImageRep* mImplementation;
};
Atil::Image没有这个getPixel函数啊，你看看Atil::Image定义image->getPixel(x, y);应该怎么修改
扫一扫
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
