VisualizationFoundation CATSupport
Usage: you must use this class as is. You should never derive it.
public class CATSupport
Base class .
Constructor and Destructor Index
- o
CATSupport(int,int,void*)
- Constructs the class from a width and an height.
- o
CATSupport(CATSupport&)
- Copy Constructor.
- o
~CATSupport()
-
Method Index
- o
AddClippingPlane(int,float*,float*,int)
- Adds a clipping plane(you cannot define more than six clipping planes).
- o
AddViewpoint(CATViewpoint*,int)
- Adds a given viewpoint.
- o
Clear()
- Clears the screen.
- o
Draw(void)
- Draws the scene.
- o
GetAntiAliasingMode()
- Returns whether or not the antialiasing mode for lines is active.
- o
GetBackgroundColor(float*,float*,float*)
- Retreives the background color.
- o
GetColorMap()
- Returns the indexed color map.
- o
GetCullVanishingRatio()
- Returns the culling vanishing ratio
- o
GetCullingPrecision()
- Returns the minimum pixel size.
- o
GetCullingPrecisionf()
- Returns the minimum pixel size.
- o
GetDefaultMaterialProperties(float&,float&,float&)
- Retreives default material properties.
- o
GetGlobalAmbientLight(float*,float*,float*)
- Retreives the global ambient light color.
- o
GetMMInSupportUnit()
- Returns the millimeter size in pixel size.
- o
GetPointToPixelScale()
- Returns the point to pixel scale (used for text and UI size regarding screen quality).
- o
GetRatioWH()
- Returns the ration heigth/width of one pixel.
- o
GetSagPrecision()
- Returns the sag precision.
- o
GetStereoMode(int*,float*)
- Retreives the stereo mode.
- o
GetViewMode(void)
- Returns the current viewer mode of the current CATSupport.
- o
GetWidthAndHeight(float&,float&)
- Retreives the heigth and width of the current CATSupport.
- o
IsAmbientActivated()
- Returns whether or not ambient light is active.
- o
IsClipped(float**,float**,int*)
- Returns the number of clipping planes.
- o
IsFogOn()
- Returns whether or not fog is active.
- o
RemoveClippingPlane()
- Resets all the clipping planes.
- o
RemoveViewpoint(CATViewpoint*)
- Removess a given viewpoint.
- o
SetAmbientActivation(unsigned int)
- Activates or Deactivates the global ambient light.
- o
SetAntiAliasingMode(int)
- Sets the antialiasing mode for lines.
- o
SetBackgroundColor(float,float,float)
- Sets the background color.
- o
SetCullVanishingRatio(float)
- Sets the culling vanishing ratio
Role:
Objects which size is greater that ratio * total scene size are never culled by pixel culling
- o
SetCullingPrecision(int)
- Gives the minimum pixel size for objects to be drawn.
- o
SetCullingPrecisionf(float)
- Gives the minimum pixel size for objects to be drawn.
- o
SetDefaultMaterialProperties(float,float,float)
- Sets default material properties.
- o
SetFogMode(int)
- Sets the fog mode.
- o
SetGlobalAmbientLight(float,float,float)
- Sets the global ambient light color.
- o
SetMMInSupportUnit(float)
- Sets one millimeter size in pixel size.
- o
SetPointToPixelScale(float)
- Returns whether the point to pixel scale can be changed on current CATSupport
- o
SetRatioWH(float)
- Sets the ratio heigth/width of one pixel.
- o
SetSagPrecision(float)
- Sets the sag in pixel size.
- o
SetStereoMode(int,float)
- Sets the stereo mode.
- o
SetViewMode(int,int)
- Sets the viewmode for viewer enclosed in the current CATSupport.
- o
SetWidthAndHeight(float,float)
- Sets the heigth and width of the current CATSupport.
- o
Swap()
- Swaps back buffer to front buffer.
- o
SwitchBack()
- Sets the back buffer as active : we are drawing into it.
- o
SwitchBackLeft()
- Sets the left back buffer as active when working in stereo mode: we are drawing into it.
- o
SwitchBackRight()
- Sets the right back buffer as active when working in stereo mode: we are drawing into it.
- o
SwitchFront()
- Sets the front buffer as active : we are drawing into it.
- o
SwitchFrontLeft()
- Sets the left front buffer as active when working in stereo mode: we are drawing into it.
- o
SwitchFrontRight()
- Sets the right front buffer as active when working in stereo mode: we are drawing into it.
- o
SynchronizeSlaveWindows()
- Synchronize slave windows together in Multi GPU case.
- o
ViewMode(int)
- Returns whether or not the given mode is active.
Constructor and Destructor
o CATSupport
| public CATSupport( | const | width, |
| const | height, |
| const | display | = NULL) |
-
Constructs the class from a width and an height.
- Parameters:
-
- width
- pixel width.
- height
- pixelheight.
- display
- diplay X. Must be NULL on WINDOWS.
o CATSupport
| public CATSupport( | const | ) |
-
Copy Constructor.
o ~CATSupport
| public virtual ~CATSupport( | ) |
-
Methods
o AddClippingPlane
| public AddClippingPlane( | const | iNbPlanes, |
| const | iPoint, |
| const | iNnormal, |
| const | iCappingPlaneSeen | = 1) |
-
Adds a clipping plane(you cannot define more than six clipping planes).
- Parameters:
-
- iNbPlanes
- number of planes.
- iPoint
- array of 3xiNbPlanes of coordinates. Each (x,y,z) represents a point belonging
to a clipping plane. And there is only one point per plane.
- iNnormal
- array of 3xiNbPlanes of coordinates. Each (x,y,z) represents a normal to one plane.
And there is only one normal per plane.
- iCappingPlaneSeen
-
- 0 = intersection between clipping planes and volumic graphical representations is not filled in
- 1 = intersection between clipping planes and volumic graphical representations is filled in
o AddViewpoint
| public virtual AddViewpoint( | | iVpt, |
| | iPlace | = 1 ) |
-
Adds a given viewpoint.
- Parameters:
-
- iVpt
- the viewpoint.
- iPlace
- integer value
- 1 = Foreground
- 0 = Background
o Clear
-
Clears the screen.
o Draw
-
Draws the scene.
o GetAntiAliasingMode
| public GetAntiAliasingMode( | ) |
-
Returns whether or not the antialiasing mode for lines is active.
- Returns:
- integer
- 0 = antialiasing is off
- 1 = antialiasing is on
o GetBackgroundColor
| public GetBackgroundColor( | | oR, |
| | oG, |
| | oB) |
-
Retreives the background color.
- Parameters:
-
- oR
- the red composant color.
- oG
- the green composant color.
- oB
- the blue composant color.
o GetColorMap
-
Returns the indexed color map.
- See also:
-
o GetCullVanishingRatio
| public GetCullVanishingRatio( | ) |
-
Returns the culling vanishing ratio
o GetCullingPrecision
| public GetCullingPrecision( | ) |
-
Returns the minimum pixel size.
o GetCullingPrecisionf
| public GetCullingPrecisionf( | ) |
-
Returns the minimum pixel size.
o GetDefaultMaterialProperties
| public GetDefaultMaterialProperties( | | oDiffAmbCoef, |
| | oSpecCoef, |
| | oShininess) |
-
Retreives default material properties.
- Parameters:
-
- oDiffAmbCoef
- the diffuse and ambient coefficient.
- oSpecCoef
- the specular coefficient.
- oShininess
- the shininess.
o GetGlobalAmbientLight
| public GetGlobalAmbientLight( | | oR, |
| | oG, |
| | oB) |
-
Retreives the global ambient light color.
- Parameters:
-
- oR
- the red composant color.
- oG
- the green composant color.
- oB
- the blue composant color.
o GetMMInSupportUnit
| public GetMMInSupportUnit( | ) |
-
Returns the millimeter size in pixel size.
o GetPointToPixelScale
| public GetPointToPixelScale( | ) |
-
Returns the point to pixel scale (used for text and UI size regarding screen quality).
o GetRatioWH
-
Returns the ration heigth/width of one pixel.
o GetSagPrecision
-
Returns the sag precision.
o GetStereoMode
| public GetStereoMode( | | oMode, |
| | oEyeGap) |
-
Retreives the stereo mode.
- Parameters:
-
- oMode
-
- 0 = off
- 1 = manual
- 2 = automatic
- oEyeGap
- gap between the eyes (model unit). Avaible only in manual mode.
o GetViewMode
-
Returns the current viewer mode of the current CATSupport.
- See also:
-
o GetWidthAndHeight
| public GetWidthAndHeight( | | oWidth, |
| | oHeight) |
-
Retreives the heigth and width of the current CATSupport.
- Parameters:
-
- oWidth
- the width.
- oHeight
- the height.
o IsAmbientActivated
| public IsAmbientActivated( | ) |
-
Returns whether or not ambient light is active.
- Returns:
- integer
- 1 = ambient ligh is active
- 0 = ambient ligh is not active
o IsClipped
| public IsClipped( | | oPoint, |
| | oNormal, |
| | oCappingPlaneSeen) |
-
Returns the number of clipping planes.
- Parameters:
-
- oPoint
- pointer to an array of 3xiNbPlanes of coordinates. Each (x,y,z) represents a point belonging
to a clipping plane. And there is only one point per plane.
- oNnormal
- pointer to an array of 3xiNbPlanes of coordinates. Each (x,y,z) represents a normal to one plane.
And there is only one normal per plane.
- oCappingPlaneSeen
-
- 0 = intersection between clipping planes and volumic graphical representations is not filled in
- 1 = intersection between clipping planes and volumic graphical representations is filled in
o IsFogOn
-
Returns whether or not fog is active.
- Returns:
- integer
- 1 = fog is active
- 0 = fog is not active
o RemoveClippingPlane
| public RemoveClippingPlane( | ) |
-
Resets all the clipping planes.
o RemoveViewpoint
| public virtual RemoveViewpoint( | | iVpt) |
-
Removess a given viewpoint.
- Parameters:
-
- iVpt
- the viewpoint.
o SetAmbientActivation
| public SetAmbientActivation( | | iOnOff) |
-
Activates or Deactivates the global ambient light.
- Parameters:
-
- iOnOff
- 0 = off.
1 = on.
o SetAntiAliasingMode
| public SetAntiAliasingMode( | const | iAntialiasingMode) |
-
Sets the antialiasing mode for lines.
- Parameters:
-
- iAntialiasingMode
-
- 0 = antialiasing is off
- 1 = antialiasing is on
o SetBackgroundColor
| public virtual SetBackgroundColor( | const | iR, |
| const | iG, |
| const | iB) |
-
Sets the background color.
- Parameters:
-
- iR
- the red composant color.
- iG
- the green composant color.
- iB
- the blue composant color.
o SetCullVanishingRatio
| public SetCullVanishingRatio( | | iRatio) |
-
Sets the culling vanishing ratio
Role:
Objects which size is greater that ratio * total scene size are never culled by pixel culling
o SetCullingPrecision
| public SetCullingPrecision( | const | iCullingPrecision) |
-
Gives the minimum pixel size for objects to be drawn.
Role:
Objects which size is less than the iCullingPrecision are not drawn.
- Parameters:
-
- iCullingPrecision
- the minimum pixel size for objects to be drawn.
o SetCullingPrecisionf
| public SetCullingPrecisionf( | const | iCullingPrecision) |
-
Gives the minimum pixel size for objects to be drawn.
Role:
Objects which size is less than the iCullingPrecision are not drawn.
- Parameters:
-
- iCullingPrecision
- the minimum pixel size for objects to be drawn.
o SetDefaultMaterialProperties
| public SetDefaultMaterialProperties( | | iDiffAmbCoef, |
| | iSpecCoef, |
| | iShininess) |
-
Sets default material properties.
- Parameters:
-
- iDiffAmbCoef
- the diffuse and ambient coefficient.
- iSpecCoef
- the specular coefficient.
- iShininess
- the shininess.
o SetFogMode
| public SetFogMode( | const | iFogMode) |
-
Sets the fog mode.
- Parameters:
-
- iFogMode
-
- 0 = fog is off
- 1= fog is on
o SetGlobalAmbientLight
| public virtual SetGlobalAmbientLight( | const | iR, |
| const | iG, |
| const | iB) |
-
Sets the global ambient light color.
- Parameters:
-
- iR
- the red composant color.
- iG
- the green composant color.
- iB
- the blue composant color.
o SetMMInSupportUnit
| public SetMMInSupportUnit( | const | iSize) |
-
Sets one millimeter size in pixel size.
- Parameters:
-
- iSize
- the pixel size .
o SetPointToPixelScale
| public virtual SetPointToPixelScale( | const | iScale) |
-
Returns whether the point to pixel scale can be changed on current CATSupport
- Parameters:
-
- iScale
- the new point to pixel scale factor.
o SetRatioWH
| public SetRatioWH( | const | iRatio) |
-
Sets the ratio heigth/width of one pixel.
Role:
it is useful when pixel is not a squarre. It is screen-dependant.
o SetSagPrecision
| public SetSagPrecision( | const | iSagPrecision) |
-
Sets the sag in pixel size.
Role:
sag is used for determining which level of details to use.
- Parameters:
-
- iSagPrecision
- the sagprecision.
o SetStereoMode
| public virtual SetStereoMode( | const | iMode, |
| const | iEyeGap) |
-
Sets the stereo mode.
- Parameters:
-
- iMode
-
- 0 = off
- 1 = manual
- 2 = automatic
- iEyeGap
- gap between the eyes (model unit). Avaible only in manual mode.
o SetViewMode
| public virtual SetViewMode( | const | iMode, |
| const | iActive) |
-
Sets the viewmode for viewer enclosed in the current CATSupport.
- Parameters:
-
- iMode:
- The viewer mode.
Legal values:
- iActive
- 0 = off.
1 = on.
o SetWidthAndHeight
| public SetWidthAndHeight( | const | iWidth, |
| const | iHeight) |
-
Sets the heigth and width of the current CATSupport.
- Parameters:
-
- iWidth
- the width.
- iHeight
- the height.
o Swap
-
Swaps back buffer to front buffer.
o SwitchBack
| public virtual SwitchBack( | ) |
-
Sets the back buffer as active : we are drawing into it.
o SwitchBackLeft
| public virtual SwitchBackLeft( | ) |
-
Sets the left back buffer as active when working in stereo mode: we are drawing into it.
o SwitchBackRight
| public virtual SwitchBackRight( | ) |
-
Sets the right back buffer as active when working in stereo mode: we are drawing into it.
o SwitchFront
| public virtual SwitchFront( | ) |
-
Sets the front buffer as active : we are drawing into it.
Role: when you are in furtive mode you draw graphical representations
into the front buffer.
o SwitchFrontLeft
| public virtual SwitchFrontLeft( | ) |
-
Sets the left front buffer as active when working in stereo mode: we are drawing into it.
o SwitchFrontRight
| public virtual SwitchFrontRight( | ) |
-
Sets the right front buffer as active when working in stereo mode: we are drawing into it.
o SynchronizeSlaveWindows
| public virtual SynchronizeSlaveWindows( | ) |
-
Synchronize slave windows together in Multi GPU case. This method is only available in the new render engine.
- Returns:
- E_FAIL it all windows fail to synchronize. S_OK if all succeed, S_FALSE if there are failure but at least one is OK.
o ViewMode
| public ViewMode( | const | iMode) |
-
Returns whether or not the given mode is active.
- Parameters:
-
- iMode
- the viewer mode.
Legal values:
This object is included in the file: CATSupport.h
If needed, your Imakefile.mk should include the module: CATVisFoundation
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.