OCC Main Page | Visualization | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

Visualization
TKV3d
Graphic3d


Graphic3d_AspectFillArea3d Class Reference

This class permits the creation and updating of
a graphic attribute context for opaque 3d
primitives (polygons, triangles, quadrilaterals)
Keywords: Face, FillArea, Triangle, Quadrangle, Polygon,
TriangleMesh, QuadrangleMesh, Edge, Border, Interior,
Color, Type, Width, Style, Hatch, Material,
BackFaceRemoval, DistinguishMode
.

#include <Graphic3d_AspectFillArea3d.hxx>

Inheritance diagram for Graphic3d_AspectFillArea3d:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT Graphic3d_AspectFillArea3d ()
 Creates a context table for fill area primitives
defined with the following default values:
.
Standard_EXPORT Graphic3d_AspectFillArea3d (const Aspect_InteriorStyle Interior, const Quantity_Color &InteriorColor, const Quantity_Color &EdgeColor, const Aspect_TypeOfLine EdgeLineType, const Standard_Real EdgeWidth, const Graphic3d_MaterialAspect &FrontMaterial, const Graphic3d_MaterialAspect &BackMaterial)
 Creates a context table for fill area primitives
defined with the specified values.
.
Standard_EXPORT void AllowBackFace ()
 Allows the display of back-facing filled
polygons.
.
Standard_EXPORT void SetBackMaterial (const Graphic3d_MaterialAspect &AMaterial)
 Modifies the surface material of internal faces
.
Standard_EXPORT void SetDistinguishOn ()
 Allows distinction between external and internal
faces of FillAreas.
.
Standard_EXPORT void SetDistinguishOff ()
 Forbids distinction between external and internal
faces of FillAreas.
.
Standard_EXPORT void SetEdgeOn ()
 The edges of FillAreas are drawn.
.
Standard_EXPORT void SetEdgeOff ()
 The edges of FillAreas are not drawn.
.
Standard_EXPORT void SetFrontMaterial (const Graphic3d_MaterialAspect &AMaterial)
 Modifies the surface material of external faces
.
Standard_EXPORT void SuppressBackFace ()
 Suppress the display of back-facing filled
polygons.
A back-facing polygon is defined as a polygon whose
vertices are in a clockwise order with respect
to screen coordinates.
.
Standard_EXPORT void SetTextureMap (const Handle(Graphic3d_TextureMap)&ATexture)
Standard_EXPORT void SetTextureMapOn ()
Standard_EXPORT void SetTextureMapOff ()
Standard_EXPORT void SetDegenerateModel (const Aspect_TypeOfDegenerateModel aModel=Aspect_TDM_WIREFRAME, const Quantity_Ratio aRatio=0.0)
 Sets the model of degeneration for the polygons
according to the degenerate ratio >= 0. & <= 1. where :
<aratio> = 0. indicate that all polygons of the graphic structure
are displayed.
<aratio> = 1. indicate that nothing is displayed in the graphic
structure.
When <aratio> is > 0 & < 1. the corresponding amount
of polygons are displayed in the graphic structure with a
random method.
Warning: the degenerate structure is shown only when
the animation and degenerate flags are set to TRUE
in V3d_View::SetAnimationMode(..)
.
Standard_EXPORT void SetPolygonOffsets (const Standard_Integer aMode, const Standard_Real aFactor=1.0, const Standard_Real aUnits=0.0)
 Sets up OpenGL polygon offsets mechanism.
<amode> parameter can contain various combinations of
Aspect_PolygonOffsetMode enumeration elements (Aspect_POM_None means
that polygon offsets are not changed).
If <amode> is different from Aspect_POM_Off and Aspect_POM_None, then <afactor> and <aunits>
arguments are used by graphic renderer to calculate a depth offset value:

offset = <afactor> * m + <aunits> * r, where
m - maximum depth slope for the polygon currently being displayed,
r - minimum window coordinates depth resolution (implementation-specific)
.
Standard_EXPORT Standard_Boolean BackFace () const
 Returns the Back Face Removal status.
Standard_True if SuppressBackFace is activated.
.
Standard_EXPORT Standard_Boolean Distinguish () const
 Returns the Distinguish Mode status.
.
Standard_EXPORT Standard_Boolean Edge () const
 Returns Standard_True if the edges are drawn and
Standard_False if the edges are not drawn.
.
Standard_EXPORT Graphic3d_MaterialAspect BackMaterial () const
 Returns the surface material of internal faces
.
Standard_EXPORT Graphic3d_MaterialAspect FrontMaterial () const
 Returns the surface material of external faces
.
Standard_EXPORT Handle_Graphic3d_TextureMap TextureMap () const
Standard_EXPORT Standard_Boolean TextureMapState () const
Standard_EXPORT Aspect_TypeOfDegenerateModel DegenerateModel (Quantity_Ratio &aRatio) const
 returns the current degeneration model and ratio
for the polygons

Standard_EXPORT void PolygonOffsets (Standard_Integer &aMode, Standard_Real &aFactor, Standard_Real &aUnits) const
 Returns current polygon offsets settings.
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Static Public Member Functions

static Standard_EXPORT void SetDefaultDegenerateModel (const Aspect_TypeOfDegenerateModel aModel=Aspect_TDM_WIREFRAME, const Quantity_Ratio aRatio=0.0)
 Sets the default model of degeneration for the polygons
which is taking in account at creation time of any
graphic structure until the model is change using
SetDegenerateModel() method.
.
static Standard_EXPORT Aspect_TypeOfDegenerateModel DefaultDegenerateModel (Quantity_Ratio &aRatio)
 returns the default degeneration model and ratio
for the polygons


Private Attributes

Standard_Boolean DistinguishModeActive
Standard_Boolean EdgeModeActive
Standard_Boolean BackFaceRemovalActive
Handle_Graphic3d_TextureMap MyTextureMap
Standard_Boolean MyTextureMapState
Graphic3d_MaterialAspect MyFrontMaterial
Graphic3d_MaterialAspect MyBackMaterial
Aspect_TypeOfDegenerateModel MyDegenerateModel
Quantity_Ratio MyDegenerateRatio
Standard_Integer MyPolygonOffsetMode
Standard_Real MyPolygonOffsetFactor
Standard_Real MyPolygonOffsetUnits

Constructor & Destructor Documentation

Standard_EXPORT Graphic3d_AspectFillArea3d::Graphic3d_AspectFillArea3d  ) 
 

Standard_EXPORT Graphic3d_AspectFillArea3d::Graphic3d_AspectFillArea3d const Aspect_InteriorStyle  Interior,
const Quantity_Color &  InteriorColor,
const Quantity_Color &  EdgeColor,
const Aspect_TypeOfLine  EdgeLineType,
const Standard_Real  EdgeWidth,
const Graphic3d_MaterialAspect FrontMaterial,
const Graphic3d_MaterialAspect BackMaterial
 


Member Function Documentation

Standard_EXPORT void Graphic3d_AspectFillArea3d::AllowBackFace  ) 
 

Standard_EXPORT Standard_Boolean Graphic3d_AspectFillArea3d::BackFace  )  const
 

Standard_EXPORT Graphic3d_MaterialAspect Graphic3d_AspectFillArea3d::BackMaterial  )  const
 

static Standard_EXPORT Aspect_TypeOfDegenerateModel Graphic3d_AspectFillArea3d::DefaultDegenerateModel Quantity_Ratio &  aRatio  )  [static]
 

Standard_EXPORT Aspect_TypeOfDegenerateModel Graphic3d_AspectFillArea3d::DegenerateModel Quantity_Ratio &  aRatio  )  const
 

Standard_EXPORT Standard_Boolean Graphic3d_AspectFillArea3d::Distinguish  )  const
 

Standard_EXPORT Standard_Boolean Graphic3d_AspectFillArea3d::Edge  )  const
 

Standard_EXPORT Graphic3d_MaterialAspect Graphic3d_AspectFillArea3d::FrontMaterial  )  const
 

Standard_EXPORT const Graphic3d_AspectFillArea3d::Handle Standard_Type   )  const
 

Reimplemented from Aspect_AspectFillArea.

Standard_EXPORT void Graphic3d_AspectFillArea3d::PolygonOffsets Standard_Integer &  aMode,
Standard_Real &  aFactor,
Standard_Real &  aUnits
const
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SetBackMaterial const Graphic3d_MaterialAspect AMaterial  ) 
 

static Standard_EXPORT void Graphic3d_AspectFillArea3d::SetDefaultDegenerateModel const Aspect_TypeOfDegenerateModel  aModel = Aspect_TDM_WIREFRAME,
const Quantity_Ratio  aRatio = 0.0
[static]
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SetDegenerateModel const Aspect_TypeOfDegenerateModel  aModel = Aspect_TDM_WIREFRAME,
const Quantity_Ratio  aRatio = 0.0
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SetDistinguishOff  ) 
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SetDistinguishOn  ) 
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SetEdgeOff  ) 
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SetEdgeOn  ) 
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SetFrontMaterial const Graphic3d_MaterialAspect AMaterial  ) 
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SetPolygonOffsets const Standard_Integer  aMode,
const Standard_Real  aFactor = 1.0,
const Standard_Real  aUnits = 0.0
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SetTextureMap const Handle(Graphic3d_TextureMap)&  ATexture  ) 
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SetTextureMapOff  ) 
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SetTextureMapOn  ) 
 

Standard_EXPORT void Graphic3d_AspectFillArea3d::SuppressBackFace  ) 
 

Standard_EXPORT Handle_Graphic3d_TextureMap Graphic3d_AspectFillArea3d::TextureMap  )  const
 

Standard_EXPORT Standard_Boolean Graphic3d_AspectFillArea3d::TextureMapState  )  const
 


Field Documentation

Standard_Boolean Graphic3d_AspectFillArea3d::BackFaceRemovalActive [private]
 

Standard_Boolean Graphic3d_AspectFillArea3d::DistinguishModeActive [private]
 

Standard_Boolean Graphic3d_AspectFillArea3d::EdgeModeActive [private]
 

Graphic3d_MaterialAspect Graphic3d_AspectFillArea3d::MyBackMaterial [private]
 

Aspect_TypeOfDegenerateModel Graphic3d_AspectFillArea3d::MyDegenerateModel [private]
 

Quantity_Ratio Graphic3d_AspectFillArea3d::MyDegenerateRatio [private]
 

Graphic3d_MaterialAspect Graphic3d_AspectFillArea3d::MyFrontMaterial [private]
 

Standard_Real Graphic3d_AspectFillArea3d::MyPolygonOffsetFactor [private]
 

Standard_Integer Graphic3d_AspectFillArea3d::MyPolygonOffsetMode [private]
 

Standard_Real Graphic3d_AspectFillArea3d::MyPolygonOffsetUnits [private]
 

Handle_Graphic3d_TextureMap Graphic3d_AspectFillArea3d::MyTextureMap [private]
 

Standard_Boolean Graphic3d_AspectFillArea3d::MyTextureMapState [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:55:39 2008 for OpenCASCADE by  doxygen 1.4.1