VisualizationFoundation CAT2DImagePixelRep

Usage: you must use this class as is. You should never derive it.


public class CAT2DImagePixelRep

Class to create a representation of a 2D image.
Role: This representation allows to constructs an image with pixels in 2D.


Constructor and Destructor Index


o CAT2DImagePixelRep(float[2],CATPixelImage*,int,int,int,int)
Constructs a 2D image representation.
o ~CAT2DImagePixelRep()

Method Index


o GetPixelImage()
Returns the 2D pixel image associated with the representation.
o Modify(float[2])
Modifies the position of the 2D image representation.
o SetAlphaMode(int)
Sets the alpha mode.

Constructor and Destructor


o CAT2DImagePixelRep
public CAT2DImagePixelRep( const iPoint,
const iPixelImage,
iZoomQuality= 0,
iXPixelOffset= 0,
iYPixelOffset= 0,
iScaleOffset= 0)
Constructs a 2D image representation.
Parameters:
iPoint
the position of the graphic primitive in a 2D space (in model coordinates).
iPixelImage
the 2D image used to create the 2D graphic primitive.
iZoomQuality
the zoom quality.
legal values:
  • 0 : no zoom available.
  • 1 : low quality zoom.
  • 2 : high quality zoom (smooth).
The default value is 0 (no zoom).
iXPixelOffset
The offset along X axis. It allows to translate the graphic primitive from the iPoint. iXPixelOffset is expressed in pixels.
legal values: the default value is 0 (no translation along X axis)
iYPixelOffset
The offset along Y axis. It allows to translate the graphic primitive from the iPoint. iYPixelOffset is expressed in pixels.
legal values: the default value is 0 (no translation along Y axis)
iScaleOffset
Do not use.
o ~CAT2DImagePixelRep
public virtual ~CAT2DImagePixelRep()

Methods


o GetPixelImage
public GetPixelImage()
Returns the 2D pixel image associated with the representation.
o Modify
public Modify( const oPoint)
Modifies the position of the 2D image representation.
Parameters:
oPoint
the position of the 2D image representation.
o SetAlphaMode
public SetAlphaMode( iOnOff)
Sets the alpha mode. Alpha mode allows to define a degree of transparency for each pixel of the 2D image representation.
Parameters:
iOnOff
the integer which defines the alpha mode.
legal values:
  • 0 : alpha mode is not activated
  • 1 : alpha mode is activated and transparency is managed as a mask:
if alpha is inferior to 128 the color is fylly transparent, if it is superior the color is fully opaque.
  • 2 : alpha mode is activated and transparency is managed as true transparency

  • This object is included in the file: CAT2DImagePixelRep.h
    If needed, your Imakefile.mk should include the module: CATVisFoundation

    Copyright © 1999-2015, Dassault Systèmes. All rights reserved.