All Frameworks Class Hierarchy This Framework Indexes Previous Next

VisualizationFoundation CATRender

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

public class CATRender

Class to create a render.
Role: The CATRender and inherited objects are the classes defining actions on graphical representations and graphical primitives. The renders are the only objects directly connected to the representations and to the primitives through their Draw methods. Mainly, the CATRender inherited objects are used to descend a representation tree from the top to the bottom. Render methods are overloaded in order to pick up information from the representation tree defining the graphical database. The CATRender is called each time a Draw is performed. With the following list of methods, it's made possible to extract any information from the graphical database:

Push/Pop Matrix: Gives the tree architecture.
DrawRepresentation: Gives the starting point for the draw of a rep.
Draw xxx: Gives information on the type of the graphical primitive that is being drawn.

Note that all these functions are sequentially called, so it's always possible to build back the list of what is being drawn and the order of the draw sequence. It'll never be possible to know exactly which type of representation is being drawn, because representations are an open class, and no application may have the knowledge of all of them.

Constructor and Destructor Index

o CATRender(CATSupport&): Constructs a render.
o ~CATRender(): Destructor

Method Index

o Draw2DArcCircle(CAT2DArcCircleGP&): Draws a 2D arc's circle.
o Draw2DArcEllipse(CAT2DArcEllipseGP&): Draws a 2D arc's ellipse.
o Draw2DGeometricText(CAT2DGeometricTextGP&): Draws a 2D geometric text.
o Draw2DLine(CAT2DLineGP&): Draws a 2D line.
o Draw2DMarker(CAT2DMarkerGP&): Draws a 2D marker.
o Draw2DPolygon(CAT2DPolygonGP&): Draws a 2D polygon.
o Draw2DQuadStrip(CAT2DQuadStripGP&): Draws a 2D quad strip.
o Draw2DRectangle(CAT2DRectangleGP&): Draws a 2D rectangle.
o Draw3DCurvedPipe(CAT3DCurvedPipeGP&): Draws a 3D curved pipe.
o Draw3DCylinder(CAT3DCylinderGP&,int): Draws a 3D cylinder.
o Draw3DEdge(CAT3DEdgeGP&): Draws a 3D edge.
o Draw3DFace(CAT3DFaceGP&): Draws a 3D face.
o Draw3DLine(CAT3DLineGP&): Draws a 3D line.
o Draw3DMarker(CAT3DMarkerGP&): Draws a 3D marker.
o Draw3DPlanarFace(CAT3DPlanarFaceGP&): Draws a 3D planar face.
o DrawDynamicGP(CATDynamicGP&): Draws a dynamic graphic primitive.
o DrawLightSource(CAT3DLightSourceGP&): Draws a 3D light source.
o DrawRepresentation(CATRep&): Draws a representation.
o DrawRepresentation(CATRep&,int,void*&): This method is called at the begining of a Rep draw.
o EndDrawRepresentation(CATRep&,void*&): This method is called at the end of a Rep draw.
o Get3DViewpoint(): Gets the render's 3D Viewpoint.
o GetCATColorMap(): Gets the render's CATColorMap.
o GetMMFromModelRatio(): Get the mm size in model unit for 2D.
o GetMMFromModelRatio(CATMathPointf&): Get the mm size in model unit for a 3D point.
o GetMMInSupportUnit(): Get the mm size in pixel.
o GetPixelFromModelRatio(): Get the pixel size in model unit for 2D.
o GetPixelFromModelRatio(CATMathPointf&): Get the pixel size in model unit for a 3D point.
o GetPixelRatioWH(): Get the pixel's ratio height/weight.
o GetSupport(): Gets the render's Support.
o GetWidthAndHeight(float&,float&): Get the support's width and height.
o IsDrawable(CATGraphicAttributeSet&): Indicates if the representation is drawable with this attribut.
o IsDrawable(CATGraphicAttributeSet&,int): Indicates if the representation is drawable with this attribut.
o IsDrawable(CATGraphicAttributeSet&,int,int)
o IsDrawable(CATGraphicAttributeSet&,CATGraphicMaterial*): Indicates if the representation is drawable with this attribut.
o IsDrawable(CATGraphicAttributeSet&,list<int>&): Indicates if the representation is drawable with this attribut.
o IsDrawable(CATGraphicAttributeSet&,list<int>&,int)
o IsDrawable(CATGraphicAttributeSet&,CAT2DBoundingBox&,int): Indicates if the representation is drawable with this attribut and this bounding box.
o IsDrawable(CATGraphicAttributeSet&,CAT3DBoundingSphere&,int): Indicates if the representation is drawable with this attribut and this bounding sphere.
o IsDrawable(CATGraphicAttributeSet&,CATRep&,CATGraphicMaterial*): Indicates if the representation is drawable with this attribut.
o IsDrawable(CATGraphicAttributeSet&,CAT2DBoundingBox&,CATRep&): Indicates if the representation is drawable with this attribut and this bounding box.
o IsDrawable(CATGraphicAttributeSet&,CAT3DBoundingSphere&,CATRep&,CATGraphicMaterial*): Indicates if the representation is drawable with this attribut and this bounding sphere.
o PopMatrix(CATRender*): Pop a matrix.
o PushMatrix(CAT3x3Matrix&): Push the 2D matrix.
o PushMatrix(CAT4x4Matrix&): Push the 3D matrix.
o SetViewMode(int,int): Sets the render's view mode.
o ViewMode(int): Gets the render's current view mode.

Constructor and Destructor

o CATRender

public CATRender( const iSupport)

Constructs a render.

Parameters:

iSupport: The

o ~CATRender

public virtual ~CATRender(

)

Destructor

Methods

o Draw2DArcCircle

public virtual Draw2DArcCircle( iGP)

Draws a 2D arc's circle.

Parameters:

iGP: The

o Draw2DArcEllipse

public virtual Draw2DArcEllipse( iGP)

Draws a 2D arc's ellipse.

Parameters:

iGP: The

o Draw2DGeometricText

public virtual Draw2DGeometricText( iGP)

Draws a 2D geometric text.

Parameters:

iGP: The

o Draw2DLine

public virtual Draw2DLine( iGP)

Draws a 2D line.

Parameters:

iGP: The

o Draw2DMarker

public virtual Draw2DMarker( iGP)

Draws a 2D marker.

Parameters:

iGP: The

o Draw2DPolygon

public virtual Draw2DPolygon( iGP)

Draws a 2D polygon.

Parameters:

iGP: The

o Draw2DQuadStrip

public virtual Draw2DQuadStrip( iGP)

Draws a 2D quad strip.

Parameters:

iGP: The

o Draw2DRectangle

public virtual Draw2DRectangle( iGP)

Draws a 2D rectangle.

Parameters:

iGP: The

o Draw3DCurvedPipe

public virtual Draw3DCurvedPipe( iGP)

Draws a 3D curved pipe.

Parameters:

iGP: The

o Draw3DCylinder

public virtual Draw3DCylinder(		`iGP`,
	const		`= 0`)

Draws a 3D cylinder.

Parameters:

iGP: The

o Draw3DEdge

public virtual Draw3DEdge( iGP)

Draws a 3D edge.

Parameters:

iGP: The

o Draw3DFace

public virtual Draw3DFace( iGP)

Draws a 3D face.

Parameters:

iGP: The

o Draw3DLine

public virtual Draw3DLine( iGP)

Draws a 3D line.

Parameters:

iGP: The

o Draw3DMarker

public virtual Draw3DMarker( iGP)

Draws a 3D marker.

Parameters:

iGP: The

o Draw3DPlanarFace

public virtual Draw3DPlanarFace( iGP)

Draws a 3D planar face.

Parameters:

iGP: The

o DrawDynamicGP

public virtual DrawDynamicGP( iGP)

Draws a dynamic graphic primitive.

Parameters:

iGP: The

o DrawLightSource

public virtual DrawLightSource( iGP)

Draws a 3D light source.

Parameters:

iGP: The

o DrawRepresentation

public virtual DrawRepresentation( iRep)

Draws a representation.

Parameters:

iRep: The representation to draw.

o DrawRepresentation

public virtual DrawRepresentation(		`iRep`,
		`iInside`,
		`iData`)

This method is called at the begining of a Rep draw. You can overload it to get in your code before the rep is drawn. You must return 1 if you want the DrawShading to be done.

Parameters:

iRep: The Rep which is going to be drawn.
iInside
iData: A pointer to the data you want to pass from DrawRep to EndDrawRep

o EndDrawRepresentation

public virtual EndDrawRepresentation(		`iRep`,
		`iData`)

This method is called at the end of a Rep draw. Return 1 if evrything's ok

Parameters:

iRep: The Rep which has been drawn.
iData: A pointer to the data you want to pass from DrawRep to EndDrawRep

o Get3DViewpoint

public virtual Get3DViewpoint(

)

Gets the render's 3D Viewpoint.

Returns:: The pointer to the 3D viewpoint.

o GetCATColorMap

public GetCATColorMap(

)

Gets the render's CATColorMap.

Returns:: The pointer to the color map.

o GetMMFromModelRatio

public GetMMFromModelRatio(

)

Get the mm size in model unit for 2D.

Returns:: The mm size in model unit.

o GetMMFromModelRatio

public GetMMFromModelRatio( const iPoint)

Get the mm size in model unit for a 3D point.

Parameters:

iPoint: The 3D point where the size is calculated.

Returns:

The mm size in model unit.

o GetMMInSupportUnit

public GetMMInSupportUnit(

)

Get the mm size in pixel.

Returns:: The mm size in pixel.

o GetPixelFromModelRatio

public GetPixelFromModelRatio(

)

Get the pixel size in model unit for 2D.

Returns:: The pixel size in model unit.

o GetPixelFromModelRatio

public GetPixelFromModelRatio( const iPoint)

Get the pixel size in model unit for a 3D point.

Parameters:

iPoint: The 3D point where the size is calculated.

Returns:

The pixel size in model unit.

o GetPixelRatioWH

public GetPixelRatioWH(

)

Get the pixel's ratio height/weight.

Returns:: The pixel's ratio.

o GetSupport

public GetSupport(

)

Gets the render's Support.

Returns:: The pointer to the support.

o GetWidthAndHeight

public GetWidthAndHeight(		`oWidth`,
		`oHeight`)

Get the support's width and height.

Parameters:

oWidth: The returned width.
oHeight: The returned height.

o IsDrawable

public virtual IsDrawable( const )

Indicates if the representation is drawable with this attribut.

Parameters:

iAttribut: The representation's attributes.

Returns:

Legal values:

0: the representation is not drawable.
1: the representation is drawable.

o IsDrawable

public virtual IsDrawable(	const	`iAttribut`,
	const	`iSubElementId`)

Indicates if the representation is drawable with this attribut.

Parameters:

iAttribut: The representation's attributes.
iSubElementId.: The representation's sub-element identificator.

Returns:

Legal values:

0: the representation is not drawable.
1: the representation is drawable.

o IsDrawable

public virtual IsDrawable(	const	`iAttribut`,
	const	`iSubElementId`,
	const	`iType`)

Deprecated:

V5R21 use IsDrawable (const CATGraphicAttributeSet &iAttribut, const int iSubElementId) instead. Indicates if the representation is drawable with this attribut.

Parameters:

iAttribut

The representation's attributes.

iSubElementId.

The representation's sub-element identificator.

iType.

Flag to update the type of representation.
Legal values:

0: the type is not updated.
1: the type is updated.

Returns:

Legal values:

0: the representation is not drawable.
1: the representation is drawable.

o IsDrawable

public virtual IsDrawable(	const	`iAttribut`,
		`iMaterial`)

Indicates if the representation is drawable with this attribut.

Parameters:

iAttribut: The representation's attributes.
iMaterial: The material to be load.

Returns:

Legal values:

0: the representation is not drawable.
1: the representation is drawable.

o IsDrawable

public virtual IsDrawable(	const	`iAttribut`,
	const	`ipSubElementIdList`)

Indicates if the representation is drawable with this attribut.

Parameters:

iAttribut: The representation's attributes.
ipSubElementIdList.: The representation's sub-elements identificators.

Returns:

Legal values:

0: the representation is not drawable.
1: the representation is drawable.

o IsDrawable

public virtual IsDrawable(	const	`iAttribut`,
	const	`ipSubElementIdList`,
	const	`iType`)

Deprecated:

V5R21 use IsDrawable (const CATGraphicAttributeSet &iAttribut, const list& ipSubElementIdList) instead. Indicates if the representation is drawable with this attribut.

Parameters:

iAttribut

The representation's attributes.

iSubElementId.

The representation's sub-elements identificators.

iType.

Flag to update the type of representation.
Legal values:

0: the type is not updated.
1: the type is updated.

Returns:

Legal values:

0: the representation is not drawable.
1: the representation is drawable.

o IsDrawable

public virtual IsDrawable(	const	`iAttribut`,
	const	`iBoundingBox`,
	const	`iSubElementId`)

Indicates if the representation is drawable with this attribut and this bounding box.

Parameters:

iAttribut: The representation's attributes.
iBoundingBox: The representation's 2D bounding box.
iSubElementId.: The representation's sub-element identificator.

Returns:

Legal values:

0: the representation is not drawable.
1: the representation is drawable.

o IsDrawable

public IsDrawable(	const	`iAttribut`,
	const	`iBoundingSphere`,
	const	`iSubElementId`)

Indicates if the representation is drawable with this attribut and this bounding sphere.

Parameters:

iAttribut: The representation's attributes.
iBoundingSphere: The representation's 3D bounding sphere.
iSubElementId.: The representation's sub-element identificator.

Returns:

Legal values:

0: the representation is not drawable.
1: the representation is drawable.

o IsDrawable

public virtual IsDrawable(	const	`iAttribut`,
	const	`iRep`,
		`iMaterial`	`= 0`)

Indicates if the representation is drawable with this attribut.

Parameters:

iAttribut: The representation's attributes.
iRep.: The representation.
iMaterial: The material to be load.

Returns:

Legal values:

0: the representation is not drawable.
1: the representation is drawable.

o IsDrawable

public virtual IsDrawable(	const	`iAttribut`,
	const	`iBoundinBox`,
	const	`iRep`)

Indicates if the representation is drawable with this attribut and this bounding box.

Parameters:

iAttribut: The representation's attributes.
iBoundingBox: The representation's 2D bounding box.
iRep: The representation.

Returns:

Legal values:

0: the representation is not drawable.
1: the representation is drawable.

o IsDrawable

public virtual IsDrawable(	const	`iAttribut`,
	const	`iBoundingSphere`,
	const	`iRep`,
		`iMaterial`	`= 0`)

Indicates if the representation is drawable with this attribut and this bounding sphere.

Parameters:

iAttribut: The representation's attributes.
iBoundingSphere: The representation's 3D bounding sphere.
iRep.: The representation.
iMaterial: The material to be load.

Returns:

Legal values:

0: the representation is not drawable.
1: the representation is drawable.

o PopMatrix

public virtual PopMatrix( ioRender)

Pop a matrix.

Parameters:

ioRender: The render created by PushMatrix to delete.

o PushMatrix

public virtual PushMatrix( iMatrix)

Push the 2D matrix.

Parameters:

iMatrix: The 2D matrix to apply.

Returns:

The pointer to the new render.

o PushMatrix

public virtual PushMatrix( iMatrix)

Push the 3D matrix.

Parameters:

iMatrix: The 3D matrix to apply.

Returns:

The pointer to the new render.

o SetViewMode

public SetViewMode(	const	`iViewMode`,
	const	`iActive`)

Sets the render's view mode.

Parameters:

iViewMode

The view mode. @see CATViewerUtility.

iActive

Legal values:

0 : the view is inactivated
1 : the view is activated

o ViewMode

public virtual ViewMode( const oViewMode)

Gets the render's current view mode.

Parameters:

oViewMode: The returned view mode.

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

VisualizationFoundation writeClassCharacteristic(); CATRender

Constructor and Destructor Index

Method Index

Constructor and Destructor

Methods

VisualizationFoundation CATRender