VisualizationFoundation CAT2DImagePixelGP
Usage: you must use this class as is. You should never derive it.
public class CAT2DImagePixelGP
Class to create a dynamic graphic primitive of a 2D image.
Role:
This graphic primitive allows to constructs an image with pixels
in 2D.
Constructor and Destructor Index
- o
CAT2DImagePixelGP(float[2],CATPixelImage*,int,int,int,int)
- Constructs a 2D image Graphic primitive.
Method Index
- o
Get(float**,CATPixelImage**,int*,int*,int*)
- Retrieves data about the 2D image Graphic primitive.
- o
ImmediateDraw(CATRender&,CATViewpoint*,CATViewport*)
- Draws a 2D image.
- o
SetAlphaMode(int)
- Sets the alpha mode.
Constructor and Destructor
o CAT2DImagePixelGP
| public CAT2DImagePixelGP( | const | iPoint, |
| const | iPixelImage, |
| | iZoomQuality | = 0, |
| | iXPixelOffset | = 0, |
| | iYPixelOffset | = 0, |
| | iScaleOffset | = 0) |
-
Constructs a 2D image Graphic primitive.
- 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.
Methods
o Get
| public Get( | | oPoint, |
| | oPixelImage, |
| | oAlpha, |
| | oXPixelOffset, |
| | oYPixelOffset) |
-
Retrieves data about the 2D image Graphic primitive.
- Parameters:
-
- oPoint
- the position of the graphic primitive in a 2D space
- oPixelImage
- the image which composes the graphic primitive.
- oAlpha
- the alpha mode (the transparent mode).
legal values:
- 0 : alpha mode is activated
- 1 : alpha mode is not activated
- oXPixelOffset
- The offset along X axis. It allows to translate the graphic primitive from
the iPoint. oXPixelOffset is expressed in pixels.
- oYPixelOffset
- The offset along Y axis. It allows to translate the graphic primitive from
the iPoint. oYPixelOffset is expressed in pixels.
o ImmediateDraw
| public virtual ImmediateDraw( | | iRender, |
| const | iViewpoint, |
| const | iViewport) |
-
Draws a 2D image.
- Parameters:
-
- iRender
- the render used to draw the 2D image.
- iViewpoint
- the viewpoint used to draw the 2D image.
- iViewport
- the viewPort used to draw the 2D image.
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
This object is included in the file: CAT2DImagePixelGP.h
If needed, your Imakefile.mk should include the module: CATVisFoundation
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.