All Frameworks Class Hierarchy This Framework Previous Next Indexes
VisualizationBase Class CATSupport
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATEventSubscriber
|
+---System.CATCallbackManager
|
+---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(CATSupport&)
- Copy Constructor.
- o
CATSupport(int,int,void*)
- Constructs the class from a width and an height.
- 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
GetCullingPrecision()
- 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
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
SetCullingPrecision(int)
- 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
SetLightViewFitting(CATVisLightViewFittingMode,CAT3DViewpoint*)
-
- o
SetMMInSupportUnit(float)
- Sets one millimeter size in pixel size.
- 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
ViewMode(int)
- Returns whether or not the given mode is active.
Constructor and Destructor
o CATSupport
-
Copy Constructor.
o CATSupport
public CATSupport( | const int | width, |
| const int | height, |
| const void* | 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 virtual ~CATSupport( | ) |
-
Methods
o AddClippingPlane
public void AddClippingPlane( | const int | iNbPlanes, |
| const float* | iPoint, |
| const float* | iNnormal, |
| const int | 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 void AddViewpoint( | CATViewpoint* | iVpt, |
| int | iPlace | = 1 ) |
-
Adds a given viewpoint.
- Parameters:
-
- iVpt
- the viewpoint.
- iPlace
- integer value
- 1 = Foreground
- 0 = Background
o Clear
public virtual void Clear( | ) |
-
Clears the screen.
o Draw
public virtual void Draw( | void | ) |
-
Draws the scene.
o GetAntiAliasingMode
public inline int GetAntiAliasingMode( | )const |
-
Returns whether or not the antialiasing mode for lines is active.
- Returns:
- integer
- 0 = antialiasing is off
- 1 = antialiasing is on
o GetBackgroundColor
public void GetBackgroundColor( | float* | oR, |
| float* | oG, |
| float* | 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:
- CATColorMap
o GetCullingPrecision
public inline int GetCullingPrecision( | )const |
-
Returns the minimum pixel size.
o GetDefaultMaterialProperties
public inline void GetDefaultMaterialProperties( | float& | oDiffAmbCoef, |
| float& | oSpecCoef, |
| float& | oShininess) |
-
Retreives default material properties.
- Parameters:
-
- oDiffAmbCoef
- the diffuse and ambient coefficient.
- oSpecCoef
- the specular coefficient.
- oShininess
- the shininess.
o GetGlobalAmbientLight
public inline void GetGlobalAmbientLight( | float* | oR, |
| float* | oG, |
| float* | 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 inline float GetMMInSupportUnit( | )const |
-
Returns the millimeter size in pixel size.
o GetRatioWH
public inline float GetRatioWH( | )const |
-
Returns the ration heigth/width of one pixel.
o GetSagPrecision
public inline float GetSagPrecision( | )const |
-
Returns the sag precision.
o GetStereoMode
public inline void GetStereoMode( | int* | oMode, |
| float* | oEyeGap) const |
-
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
public int GetViewMode( | void | ) const |
-
Returns the current viewer mode of the current CATSupport.
- See also:
- CATViewModeType
o GetWidthAndHeight
public inline void GetWidthAndHeight( | float& | oWidth, |
| float& | oHeight)const |
-
Retreives the heigth and width of the current CATSupport.
- Parameters:
-
- oWidth
- the width.
- oHeight
- the height.
o IsAmbientActivated
public inline unsigned int 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 inline int IsClipped( | float** | oPoint, |
| float** | oNormal, |
| int* | 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
public inline int IsFogOn( | )const |
-
Returns whether or not fog is active.
- Returns:
- integer
- 1 = fog is active
- 0 = fog is not active
o RemoveClippingPlane
public void RemoveClippingPlane( | ) |
-
Resets all the clipping planes.
o RemoveViewpoint
-
Removess a given viewpoint.
- Parameters:
-
- iVpt
- the viewpoint.
o SetAmbientActivation
public void SetAmbientActivation( | unsigned int | iOnOff) |
-
Activates or Deactivates the global ambient light.
- Parameters:
-
- iOnOff
- 0 = off.
1 = on.
o SetAntiAliasingMode
public inline void SetAntiAliasingMode( | const int | iAntialiasingMode) |
-
Sets the antialiasing mode for lines.
- Parameters:
-
- iAntialiasingMode
-
- 0 = antialiasing is off
- 1 = antialiasing is on
o SetBackgroundColor
public virtual void SetBackgroundColor( | const float | iR, |
| const float | iG, |
| const float | iB) |
-
Sets the background color.
- Parameters:
-
- iR
- the red composant color.
- iG
- the green composant color.
- iB
- the blue composant color.
o SetCullingPrecision
public inline void SetCullingPrecision( | const int | 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 inline void SetDefaultMaterialProperties( | float | iDiffAmbCoef, |
| float | iSpecCoef, |
| float | iShininess) |
-
Sets default material properties.
- Parameters:
-
- iDiffAmbCoef
- the diffuse and ambient coefficient.
- iSpecCoef
- the specular coefficient.
- iShininess
- the shininess.
o SetFogMode
public inline void SetFogMode( | const int | iFogMode) |
-
Sets the fog mode.
- Parameters:
-
- iFogMode
-
- 0 = fog is off
- 1= fog is on
o SetGlobalAmbientLight
public virtual void SetGlobalAmbientLight( | const float | iR, |
| const float | iG, |
| const float | iB) |
-
Sets the global ambient light color.
- Parameters:
-
- iR
- the red composant color.
- iG
- the green composant color.
- iB
- the blue composant color.
o SetLightViewFitting
public void SetLightViewFitting( | const CATVisLightViewFittingMode | i_lightViewFitting, |
| CAT3DViewpoint* | ) |
-
o SetMMInSupportUnit
public inline void SetMMInSupportUnit( | const float | iSize) |
-
Sets one millimeter size in pixel size.
- Parameters:
-
- iSize
- the pixel size .
o SetRatioWH
public inline void SetRatioWH( | const float | 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 inline void SetSagPrecision( | const float | 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 void SetStereoMode( | const int | iMode, |
| const float | 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 void SetViewMode( | const int | iMode, |
| const int | iActive) |
-
Sets the viewmode for viewer enclosed in the current CATSupport.
- Parameters:
-
- iMode:
- The viewer mode.
Legal values:
CATViewModeType
- iActive
- 0 = off.
1 = on.
o SetWidthAndHeight
public inline void SetWidthAndHeight( | const float | iWidth, |
| const float | iHeight) |
-
Sets the heigth and width of the current CATSupport.
- Parameters:
-
- iWidth
- the width.
- iHeight
- the height.
o Swap
public virtual void Swap( | ) |
-
Swaps back buffer to front buffer.
o SwitchBack
public virtual void SwitchBack( | ) |
-
Sets the back buffer as active : we are drawing into it.
o SwitchBackLeft
public virtual void SwitchBackLeft( | ) |
-
Sets the left back buffer as active when working in stereo mode: we are drawing into it.
o SwitchBackRight
public virtual void SwitchBackRight( | ) |
-
Sets the right back buffer as active when working in stereo mode: we are drawing into it.
o SwitchFront
public virtual void 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 void SwitchFrontLeft( | ) |
-
Sets the left front buffer as active when working in stereo mode: we are drawing into it.
o SwitchFrontRight
public virtual void SwitchFrontRight( | ) |
-
Sets the right front buffer as active when working in stereo mode: we are drawing into it.
o ViewMode
public int ViewMode( | const int | iMode) const |
-
Returns whether or not the given mode is active.
- Parameters:
-
- iMode
- the viewer mode.
Legal values:
CATViewModeType
This object is included in the file: CATSupport.h
If needed, your Imakefile.mk should include the module: CATViz