# Visualization
TKService
Image

# Image_DIndexedImage Class Reference

`#include <Image_DIndexedImage.hxx>`

Inheritance diagram for Image_DIndexedImage:

[legend]

## Public Member Functions

virtual Standard_EXPORT void | Destroy ()
| Image destructor. .
| ~Image_DIndexedImage ()
Standard_EXPORT void | SetBackgroundPixel (const Aspect_IndexPixel &aPixel)
Standard_EXPORT const Aspect_IndexPixel & | BackgroundPixel () const
Standard_EXPORT const Aspect_IndexPixel & | Pixel (const Standard_Integer X, const Standard_Integer Y) const
const Aspect_IndexPixel & | operator() (const Standard_Integer X, const Standard_Integer Y) const
Standard_EXPORT void | SetPixel (const Standard_Integer X, const Standard_Integer Y, const Aspect_IndexPixel &aPixel)
Standard_EXPORT Aspect_IndexPixel & | MutPixel (const Standard_Integer X, const Standard_Integer Y)
Aspect_IndexPixel & | operator() (const Standard_Integer X, const Standard_Integer Y)
Standard_EXPORT void | SetRow (const Standard_Integer X, const Standard_Integer Y, const Image_PixelRowOfDIndexedImage &aRow)
Standard_EXPORT void | Row (const Standard_Integer X, const Standard_Integer Y, Image_PixelRowOfDIndexedImage &aRow) const
Standard_EXPORT void | SwapRow (const Standard_Integer I, const Standard_Integer J)
Standard_EXPORT void | SwapCol (const Standard_Integer I, const Standard_Integer J)
Standard_EXPORT void | Zoom (const Image_PixelInterpolation &anInterpolation, const Standard_Real aCoefX, const Standard_Real aCoefY)
Standard_EXPORT void | Rotate (const Image_PixelInterpolation &anInterpolation, const Quantity_PlaneAngle aAngle)
Standard_EXPORT void | Translate (const Image_PixelInterpolation &anInterpolation, const Standard_Real DX, const Standard_Real DY)
Standard_EXPORT void | Affine (const Image_PixelInterpolation &anInterpolation, const gp_GTrsf2d &Trsf)
Standard_EXPORT void | Affine (const Image_PixelInterpolation &anInterpolation, const gp_Trsf &Trsf)
virtual Standard_EXPORT void | InternalDup (const Handle(Image_Image)&anImage)
| Duplicates an Image. .
Standard_EXPORT void | SetOrigin (const Standard_Integer x, const Standard_Integer y)
| Sets Image origin, for Rotation, copy between image ... Image origin is on the TOP LEFT . Y axis goes TOP to DOWN , X axis goes LEFT to RIGHT. .
Standard_EXPORT Standard_Integer | LowerX () const
| Returns the lower X Image coordinate ( X Origin ). .
Standard_EXPORT Standard_Integer | UpperX () const
| Returns the upper X Image coordinate ( X Origin + Image width - 1 ). .
Standard_EXPORT Standard_Integer | Width () const
| Returns the Image width. .
Standard_EXPORT Standard_Integer | LowerY () const
| Returns the lower Y Image coordinate ( Y Origin ). .
Standard_EXPORT Standard_Integer | UpperY () const
| Returns the upper Y Image coordinate ( Y Origin + Image height - 1 ). .
Standard_EXPORT Standard_Integer | Height () const
| Returns the Image height. .
Standard_EXPORT void | Resize (const Standard_Real XOffset, const Standard_Real XScale, const Standard_Real YOffset, const Standard_Real YScale)
| Resize an Image. Image Pixel are left unchanged at there absolute positon. Resulting Image can be clipped. newLowerX = LowerX()*XScale + XOffset newLowerY = LowerY()*YScale + YOffset newUpperX = UpperX()*XScale + XOffset newUpperY = UpperY()*YScale + YOffset newWidth = Width() *XScale newHeight = Height()*YScale .
virtual Standard_EXPORT Image_TypeOfImage | Type () const =0
| Returns the ImageType TOI_ColorImage or TOI_PseudoColorImage .
Standard_EXPORT Standard_Boolean | isSamePixel (const Standard_Integer X, const Standard_Integer Y, const Handle(Image_Image)&anotherImage, const Standard_Integer anotherX, const Standard_Integer anotherY) const
| Returns True if me->Pixel(X,Y) is equal to anotherImage->Pixel(anotherX,anotherY) .
Standard_EXPORT void | Pixel (const Standard_Integer X, const Standard_Integer Y, Aspect_Pixel &aPixel) const
| Get the Image Pixel Value at X,Y coordinate in aPixel. Warning: aPixel must have the same type than Image Pixel. .
Standard_EXPORT void | SetPixel (const Standard_Integer X, const Standard_Integer Y, const Aspect_Pixel &aPixel)
| Store aPixel in the Image at X,Y coordinate . Warning: aPixel must have the same type than Image Pixel. .
Standard_EXPORT void | Pixel (const Standard_Integer X, const Standard_Integer Y, Image_PixelAddress &aPixel) const
| Get the Image Pixel Value at X,Y coordinate in aPixel. Warning: aPixel must have the same type than Image Pixel. .
Standard_EXPORT void | SetPixel (const Standard_Integer X, const Standard_Integer Y, const Image_PixelAddress &aPixel)
| Store aPixel in the Image at X,Y coordinate . Warning: aPixel must have the same type than Image Pixel. .
Standard_EXPORT void | Transpose (const Image_FlipType aType)
| Transpose an Image( flipping across horizontal axis or vertical axis, or across diagonal... ) This geometric transformation preserves all Image Pixels. We don't need to interpolate pixels . Warning : Image size change during Transpose. .
Standard_EXPORT void | Clip (const Standard_Integer X, const Standard_Integer Y, const Standard_Integer Width, const Standard_Integer Height)
| Extract a SubImage starting at coordinate X,Y to (X+Width-1),(Y+Height-1). Warning : the Image size and origin change, new origin is X,Y ; new size is Width,Height. .
Standard_EXPORT void | Shift (const Standard_Integer XShifth, const Standard_Integer YShift)
| Translate an Image XShift pixel Right, YShift Down . Shift parameter are Integer value. .
Standard_EXPORT void | Fill (const Handle(Image_Image)&SrcImage)
| Fill me with SrcImage. SrcImage pixel are copied starting at SrcImage->LowerX(),SrcImage->LowerY() in MyPixelField. SrcImage Pixel are clipped outside <me>. .
Standard_EXPORT void | Fill (const Handle(Image_Image)&SrcImage, const Standard_Integer SrcX, const Standard_Integer SrcY, const Standard_Integer SrcWidth, const Standard_Integer SrcHeight, const Standard_Integer X, const Standard_Integer Y)
| Fill me with a SubImage of SrcImage starting from SrcX, SrcY to (SrcX+SrcWidth-1),(SrcY+SrcHeight-1) in Src Image coordinate. SrcImage SubImage pixels are copied starting at X,Y in MyPixelField. SrcImage Pixel are clipped outside <me>. .
Standard_EXPORT void | FillRect (const Aspect_IndexPixel &aPixel, const Standard_Integer X, const Standard_Integer Y, const Standard_Integer Width, const Standard_Integer Height)
Standard_EXPORT void | DrawRect (const Aspect_IndexPixel &aPixel, const Standard_Integer X, const Standard_Integer Y, const Standard_Integer Width, const Standard_Integer Height)
Standard_EXPORT void | DrawLine (const Aspect_IndexPixel &aPixel, const Standard_Integer X1, const Standard_Integer Y1, const Standard_Integer X2, const Standard_Integer Y2)
Standard_EXPORT void | Clear ()
| Fill the entire Image with the BackgroundPixel. .
Standard_EXPORT void | Dump () const
| Debug .
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Protected Member Functions

Standard_EXPORT | Image_DIndexedImage (const Standard_Integer x, const Standard_Integer y, const Standard_Integer dx, const Standard_Integer dy, const Aspect_IndexPixel &BackPixel)

## Private Member Functions

Standard_EXPORT void | FlipHorizontal ()
Standard_EXPORT void | FlipVertical ()
Standard_EXPORT void | FlipMainDiagonal ()
Standard_EXPORT void | FlipAntiDiagonal ()
Standard_EXPORT void | Rotate90 ()
Standard_EXPORT void | Rotate180 ()
Standard_EXPORT void | Rotate270 ()
Standard_EXPORT const Image_PixelFieldOfDIndexedImage & | PixelField () const
Standard_EXPORT void | PixelFieldCopyTo (Image_PixelFieldOfDIndexedImage &Dst, const Standard_Integer LowR, const Standard_Integer LowC, const Standard_Integer UpR, const Standard_Integer UpC, const Standard_Integer DstLowR, const Standard_Integer DstLowC) const
Standard_EXPORT void | PixelFieldCopyFrom (const Image_PixelFieldOfDIndexedImage &Dst, const Standard_Integer LowR, const Standard_Integer LowC, const Standard_Integer UpR, const Standard_Integer UpC, const Standard_Integer DstLowR, const Standard_Integer DstLowC)
Standard_EXPORT void | PixelFieldDestroy ()
Standard_EXPORT void | CirclePixels (const Aspect_IndexPixel &Pixel, const Standard_Integer XCenter, const Standard_Integer YCenter, const Standard_Integer x, const Standard_Integer y, const Standard_Integer LowX, const Standard_Integer LowY, const Standard_Integer UpX, const Standard_Integer UpY)

## Private Attributes

Standard_Integer | myX
Standard_Integer | myY
Standard_Address | myPixelField
Aspect_IndexPixel | myBackgroundPixel

## Constructor & Destructor Documentation

Image_DIndexedImage::~Image_DIndexedImage | ( |  | ) | `[inline]`

Standard_EXPORT Image_DIndexedImage::Image_DIndexedImage | ( | const Standard_Integer | x,
|  | const Standard_Integer | y,
|  | const Standard_Integer | dx,
|  | const Standard_Integer | dy,
|  | const Aspect_IndexPixel & | BackPixel
| ) | `[protected]`

## Member Function Documentation

Standard_EXPORT void Image_DIndexedImage::Affine | ( | const Image_PixelInterpolation & | anInterpolation,
|  | const gp_Trsf & | Trsf
| ) |

Standard_EXPORT void Image_DIndexedImage::Affine | ( | const Image_PixelInterpolation & | anInterpolation,
|  | const gp_GTrsf2d & | Trsf
| ) |

Standard_EXPORT const Aspect_IndexPixel& Image_DIndexedImage::BackgroundPixel | ( |  | ) | const

Standard_EXPORT void Image_DIndexedImage::CirclePixels | ( | const Aspect_IndexPixel & | Pixel,
|  | const Standard_Integer | XCenter,
|  | const Standard_Integer | YCenter,
|  | const Standard_Integer | x,
|  | const Standard_Integer | y,
|  | const Standard_Integer | LowX,
|  | const Standard_Integer | LowY,
|  | const Standard_Integer | UpX,
|  | const Standard_Integer | UpY
| ) | `[private]`

Standard_EXPORT void Image_DIndexedImage::Clear | ( |  | ) | `[virtual]`

| Implements Image_Image.

Standard_EXPORT void Image_DIndexedImage::Clip | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Standard_Integer | Width,
|  | const Standard_Integer | Height
| ) | `[virtual]`

| Implements Image_Image.

virtual Standard_EXPORT void Image_DIndexedImage::Destroy | ( |  | ) | `[virtual]`

| Reimplemented from Image_Image.

Standard_EXPORT void Image_DIndexedImage::DrawLine | ( | const Aspect_IndexPixel & | aPixel,
|  | const Standard_Integer | X1,
|  | const Standard_Integer | Y1,
|  | const Standard_Integer | X2,
|  | const Standard_Integer | Y2
| ) |

Standard_EXPORT void Image_DIndexedImage::DrawRect | ( | const Aspect_IndexPixel & | aPixel,
|  | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Standard_Integer | Width,
|  | const Standard_Integer | Height
| ) |

Standard_EXPORT void Image_DIndexedImage::Dump | ( |  | ) | const`[virtual]`

| Implements Image_Image.

Standard_EXPORT void Image_DIndexedImage::Fill | ( | const Handle(Image_Image)& | SrcImage,
|  | const Standard_Integer | SrcX,
|  | const Standard_Integer | SrcY,
|  | const Standard_Integer | SrcWidth,
|  | const Standard_Integer | SrcHeight,
|  | const Standard_Integer | X,
|  | const Standard_Integer | Y
| ) | `[virtual]`

| Implements Image_Image.

Standard_EXPORT void Image_DIndexedImage::Fill | ( | const Handle(Image_Image)& | SrcImage | ) | `[virtual]`

| Implements Image_Image.

Standard_EXPORT void Image_DIndexedImage::FillRect | ( | const Aspect_IndexPixel & | aPixel,
|  | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Standard_Integer | Width,
|  | const Standard_Integer | Height
| ) |

Standard_EXPORT void Image_DIndexedImage::FlipAntiDiagonal | ( |  | ) | `[private]`

Standard_EXPORT void Image_DIndexedImage::FlipHorizontal | ( |  | ) | `[private]`

Standard_EXPORT void Image_DIndexedImage::FlipMainDiagonal | ( |  | ) | `[private]`

Standard_EXPORT void Image_DIndexedImage::FlipVertical | ( |  | ) | `[private]`

Standard_EXPORT const Image_DIndexedImage::Handle | ( | Standard_Type |  | ) | const

| Reimplemented from Image_Image. Reimplemented in Image_PseudoColorImage.

Standard_EXPORT Standard_Integer Image_DIndexedImage::Height | ( |  | ) | const`[virtual]`

| Implements Image_Image.

virtual Standard_EXPORT void Image_DIndexedImage::InternalDup | ( | const Handle(Image_Image)& | anImage | ) | `[virtual]`

| Implements Image_Image.

Standard_EXPORT Standard_Boolean Image_DIndexedImage::isSamePixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Handle(Image_Image)& | anotherImage,
|  | const Standard_Integer | anotherX,
|  | const Standard_Integer | anotherY
| ) | const`[virtual]`

| Implements Image_Image.

Standard_EXPORT Standard_Integer Image_DIndexedImage::LowerX | ( |  | ) | const`[virtual]`

| Implements Image_Image.

Standard_EXPORT Standard_Integer Image_DIndexedImage::LowerY | ( |  | ) | const`[virtual]`

| Implements Image_Image.

Standard_EXPORT Aspect_IndexPixel& Image_DIndexedImage::MutPixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y
| ) |

Aspect_IndexPixel& Image_DIndexedImage::operator() | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y
| ) | `[inline]`

const Aspect_IndexPixel& Image_DIndexedImage::operator() | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y
| ) | const`[inline]`

Standard_EXPORT void Image_DIndexedImage::Pixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | Image_PixelAddress & | aPixel
| ) | const`[virtual]`

| Implements Image_Image.

Standard_EXPORT void Image_DIndexedImage::Pixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | Aspect_Pixel & | aPixel
| ) | const`[virtual]`

| Implements Image_Image.

Standard_EXPORT const Aspect_IndexPixel& Image_DIndexedImage::Pixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y
| ) | const

Standard_EXPORT const Image_PixelFieldOfDIndexedImage& Image_DIndexedImage::PixelField | ( |  | ) | const`[private]`

Standard_EXPORT void Image_DIndexedImage::PixelFieldCopyFrom | ( | const Image_PixelFieldOfDIndexedImage & | Dst,
|  | const Standard_Integer | LowR,
|  | const Standard_Integer | LowC,
|  | const Standard_Integer | UpR,
|  | const Standard_Integer | UpC,
|  | const Standard_Integer | DstLowR,
|  | const Standard_Integer | DstLowC
| ) | `[private]`

Standard_EXPORT void Image_DIndexedImage::PixelFieldCopyTo | ( | Image_PixelFieldOfDIndexedImage & | Dst,
|  | const Standard_Integer | LowR,
|  | const Standard_Integer | LowC,
|  | const Standard_Integer | UpR,
|  | const Standard_Integer | UpC,
|  | const Standard_Integer | DstLowR,
|  | const Standard_Integer | DstLowC
| ) | const`[private]`

Standard_EXPORT void Image_DIndexedImage::PixelFieldDestroy | ( |  | ) | `[private]`

Standard_EXPORT void Image_DIndexedImage::Resize | ( | const Standard_Real | XOffset,
|  | const Standard_Real | XScale,
|  | const Standard_Real | YOffset,
|  | const Standard_Real | YScale
| ) | `[virtual]`

| Implements Image_Image.

Standard_EXPORT void Image_DIndexedImage::Rotate | ( | const Image_PixelInterpolation & | anInterpolation,
|  | const Quantity_PlaneAngle | aAngle
| ) |

Standard_EXPORT void Image_DIndexedImage::Rotate180 | ( |  | ) | `[private]`

Standard_EXPORT void Image_DIndexedImage::Rotate270 | ( |  | ) | `[private]`

Standard_EXPORT void Image_DIndexedImage::Rotate90 | ( |  | ) | `[private]`

Standard_EXPORT void Image_DIndexedImage::Row | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | Image_PixelRowOfDIndexedImage & | aRow
| ) | const

Standard_EXPORT void Image_DIndexedImage::SetBackgroundPixel | ( | const Aspect_IndexPixel & | aPixel | ) |

Standard_EXPORT void Image_DIndexedImage::SetOrigin | ( | const Standard_Integer | x,
|  | const Standard_Integer | y
| ) | `[virtual]`

| Implements Image_Image.

Standard_EXPORT void Image_DIndexedImage::SetPixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Image_PixelAddress & | aPixel
| ) | `[virtual]`

| Implements Image_Image.

Standard_EXPORT void Image_DIndexedImage::SetPixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Aspect_Pixel & | aPixel
| ) | `[virtual]`

| Implements Image_Image.

Standard_EXPORT void Image_DIndexedImage::SetPixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Aspect_IndexPixel & | aPixel
| ) |

Standard_EXPORT void Image_DIndexedImage::SetRow | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Image_PixelRowOfDIndexedImage & | aRow
| ) |

Standard_EXPORT void Image_DIndexedImage::Shift | ( | const Standard_Integer | XShifth,
|  | const Standard_Integer | YShift
| ) | `[virtual]`

| Implements Image_Image.

Standard_EXPORT void Image_DIndexedImage::SwapCol | ( | const Standard_Integer | I,
|  | const Standard_Integer | J
| ) |

Standard_EXPORT void Image_DIndexedImage::SwapRow | ( | const Standard_Integer | I,
|  | const Standard_Integer | J
| ) |

Standard_EXPORT void Image_DIndexedImage::Translate | ( | const Image_PixelInterpolation & | anInterpolation,
|  | const Standard_Real | DX,
|  | const Standard_Real | DY
| ) |

Standard_EXPORT void Image_DIndexedImage::Transpose | ( | const Image_FlipType | aType | ) | `[virtual]`

| Implements Image_Image.

virtual Standard_EXPORT Image_TypeOfImage Image_DIndexedImage::Type | ( |  | ) | const`[pure virtual]`

| Implements Image_Image. Implemented in Image_PseudoColorImage.

Standard_EXPORT Standard_Integer Image_DIndexedImage::UpperX | ( |  | ) | const`[virtual]`

| Implements Image_Image.

Standard_EXPORT Standard_Integer Image_DIndexedImage::UpperY | ( |  | ) | const`[virtual]`

| Implements Image_Image.

Standard_EXPORT Standard_Integer Image_DIndexedImage::Width | ( |  | ) | const`[virtual]`

| Implements Image_Image.

Standard_EXPORT void Image_DIndexedImage::Zoom | ( | const Image_PixelInterpolation & | anInterpolation,
|  | const Standard_Real | aCoefX,
|  | const Standard_Real | aCoefY
| ) |

## Field Documentation

Aspect_IndexPixel Image_DIndexedImage::myBackgroundPixel `[private]`

Standard_Address Image_DIndexedImage::myPixelField `[private]`

Standard_Integer Image_DIndexedImage::myX `[private]`

Standard_Integer Image_DIndexedImage::myY `[private]`

The documentation for this class was generated from the following file:

- Image_DIndexedImage.hxx