Open CASCADE Technology  7.1.0.beta
Public Member Functions | Data Fields | Protected Attributes

Graphic3d_AspectFillArea3d Class Reference

This class defines graphic attributes for opaque 3d primitives (polygons, triangles, quadrilaterals). More...

#include <Graphic3d_AspectFillArea3d.hxx>

Inheritance diagram for Graphic3d_AspectFillArea3d:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_AspectFillArea3d ()
 Creates a context table for fill area primitives defined with the following default values: More...
 
 Graphic3d_AspectFillArea3d (const Aspect_InteriorStyle theInterior, const Quantity_Color &theInteriorColor, const Quantity_Color &theEdgeColor, const Aspect_TypeOfLine theEdgeLineType, const Standard_Real theEdgeWidth, const Graphic3d_MaterialAspect &theFrontMaterial, const Graphic3d_MaterialAspect &theBackMaterial)
 Creates a context table for fill area primitives defined with the specified values. Display of back-facing filled polygons. No distinction between external and internal faces of FillAreas. The edges are not drawn. Polygon offset parameters: mode = Aspect_POM_None, factor = 1., units = 0. More...
 
Aspect_InteriorStyle InteriorStyle () const
 Return interior rendering style (Aspect_IS_EMPTY by default, which means nothing will be rendered!). More...
 
void SetInteriorStyle (const Aspect_InteriorStyle theStyle)
 Modifies the interior type used for rendering. More...
 
const Quantity_ColorInteriorColor () const
 Return interior color. More...
 
const Quantity_ColorRGBAInteriorColorRGBA () const
 Return interior color. More...
 
void SetInteriorColor (const Quantity_Color &theColor)
 Modifies the color of the interior of the face. More...
 
const Quantity_ColorBackInteriorColor () const
 Return back interior color. More...
 
const Quantity_ColorRGBABackInteriorColorRGBA () const
 Return back interior color. More...
 
void SetBackInteriorColor (const Quantity_Color &theColor)
 Modifies the color of the interior of the back face. More...
 
const Graphic3d_MaterialAspectFrontMaterial () const
 Returns the surface material of external faces. More...
 
void SetFrontMaterial (const Graphic3d_MaterialAspect &theMaterial)
 Modifies the surface material of external faces. More...
 
const Graphic3d_MaterialAspectBackMaterial () const
 Returns the surface material of internal faces. More...
 
void SetBackMaterial (const Graphic3d_MaterialAspect &theMaterial)
 Modifies the surface material of internal faces. More...
 
bool ToSuppressBackFaces () const
 Returns true if back faces should be suppressed (true by default). More...
 
void SetSuppressBackFaces (bool theToSuppress)
 Assign back faces culling flag. More...
 
bool BackFace () const
 Returns true if back faces should be suppressed (true by default). More...
 
void AllowBackFace ()
 Allows the display of back-facing filled polygons. More...
 
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. More...
 
bool Distinguish () const
 Returns true if material properties should be distinguished for back and front faces (false by default). More...
 
void SetDistinguish (bool toDistinguish)
 Set material distinction between front and back faces. More...
 
void SetDistinguishOn ()
 Allows material distinction between front and back faces. More...
 
void SetDistinguishOff ()
 Forbids material distinction between front and back faces. More...
 
const Handle< Graphic3d_ShaderProgram > & ShaderProgram () const
 Return shader program. More...
 
void SetShaderProgram (const Handle< Graphic3d_ShaderProgram > &theProgram)
 Sets up OpenGL/GLSL shader program. More...
 
const Handle< Graphic3d_TextureMap > & TextureMap () const
 Return texture to be mapped. More...
 
void SetTextureMap (const Handle< Graphic3d_TextureMap > &theTexture)
 Assign texture to be mapped. See also SetTextureMap() to actually activate texture mapping. More...
 
bool ToMapTexture () const
 Return true if texture mapping is enabled (false by default). More...
 
bool TextureMapState () const
 Return true if texture mapping is enabled (false by default). More...
 
void SetTextureMapOn ()
 Enable texture mapping (has no effect if texture is not set). More...
 
void SetTextureMapOff ()
 Disable texture mapping. More...
 
const Graphic3d_PolygonOffsetPolygonOffset () const
 Returns current polygon offsets settings. More...
 
void PolygonOffsets (Standard_Integer &theMode, Standard_ShortReal &theFactor, Standard_ShortReal &theUnits) const
 Returns current polygon offsets settings. More...
 
void SetPolygonOffsets (const Standard_Integer theMode, const Standard_ShortReal theFactor=1.0f, const Standard_ShortReal theUnits=0.0f)
 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: More...
 
bool ToDrawEdges () const
 Returns true if edges should be drawn (false by default). More...
 
void SetDrawEdges (bool theToDraw)
 Set if edges should be drawn or not. More...
 
bool Edge () const
 Returns true if edges should be drawn. More...
 
void SetEdgeOn ()
 The edges of FillAreas are drawn. More...
 
void SetEdgeOff ()
 The edges of FillAreas are not drawn. More...
 
const Quantity_ColorEdgeColor () const
 Return color of edges. More...
 
const Quantity_ColorRGBAEdgeColorRGBA () const
 Return color of edges. More...
 
void SetEdgeColor (const Quantity_Color &theColor)
 Modifies the color of the edge of the face. More...
 
Aspect_TypeOfLine EdgeLineType () const
 Return edges line type. More...
 
void SetEdgeLineType (const Aspect_TypeOfLine theType)
 Modifies the edge line type. More...
 
Standard_ShortReal EdgeWidth () const
 Return width for edges in pixels. More...
 
void SetEdgeWidth (const Standard_Real theWidth)
 Modifies the edge thickness Warning: Raises AspectFillAreaDefinitionError if the width is a negative value. More...
 
Aspect_HatchStyle HatchStyle () const
 Returns the hatch type used when InteriorStyle is IS_HATCH. More...
 
void SetHatchStyle (const Aspect_HatchStyle theStyle)
 Modifies the hatch type used when InteriorStyle is IS_HATCH. More...
 
 Standard_DEPRECATED ("Deprecated method Values() should be replaced by individual property getters") void Values(Aspect_InteriorStyle &theStyle
 Returns the current values. More...
 
 Standard_DEPRECATED ("Deprecated method Values() should be replaced by individual property getters") void Values(Aspect_InteriorStyle &theStyle
 Returns the current values. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Data Fields

Quantity_ColortheIntColor
 
Quantity_Color Quantity_ColortheEdgeColor
 
Quantity_Color Quantity_Color Aspect_TypeOfLinetheType
 
Quantity_Color Quantity_Color Aspect_TypeOfLine Standard_Real &theWidth const
 
 theIntColor = myInteriorColor.GetRGB()
 
 theEdgeColor = myEdgeColor.GetRGB()
 
 theType = myEdgeType
 
 theWidth = myEdgeWidth
 
Quantity_Color Quantity_ColortheBackIntColor
 
Quantity_Color Quantity_Color Quantity_ColortheEdgeColor
 
Quantity_Color Quantity_Color Quantity_Color Aspect_TypeOfLinetheType
 
Quantity_Color Quantity_Color Quantity_Color Aspect_TypeOfLine Standard_Real &theWidth const
 
 theBackIntColor = myBackInteriorColor.GetRGB()
 

Protected Attributes

Handle< Graphic3d_ShaderProgrammyProgram
 
Handle< Graphic3d_TextureMapmyTextureMap
 
Graphic3d_MaterialAspect myFrontMaterial
 
Graphic3d_MaterialAspect myBackMaterial
 
Quantity_ColorRGBA myInteriorColor
 
Quantity_ColorRGBA myBackInteriorColor
 
Quantity_ColorRGBA myEdgeColor
 
Aspect_InteriorStyle myInteriorStyle
 
Aspect_TypeOfLine myEdgeType
 
Standard_ShortReal myEdgeWidth
 
Aspect_HatchStyle myHatchStyle
 
Graphic3d_PolygonOffset myPolygonOffset
 
bool myToDistinguishMaterials
 
bool myToDrawEdges
 
bool myToSuppressBackFaces
 
bool myToMapTexture
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

This class defines graphic attributes for opaque 3d primitives (polygons, triangles, quadrilaterals).

Constructor & Destructor Documentation

Graphic3d_AspectFillArea3d::Graphic3d_AspectFillArea3d ( )

Creates a context table for fill area primitives defined with the following default values:

InteriorStyle : Aspect_IS_EMPTY InteriorColor : Quantity_NOC_CYAN1 EdgeColor : Quantity_NOC_WHITE EdgeLineType : Aspect_TOL_SOLID EdgeWidth : 1.0 FrontMaterial : NOM_BRASS BackMaterial : NOM_BRASS HatchStyle : Aspect_HS_VERTICAL

Display of back-facing filled polygons. No distinction between external and internal faces of FillAreas. The edges are not drawn. Polygon offset parameters: mode = Aspect_POM_None, factor = 1., units = 0.

Graphic3d_AspectFillArea3d::Graphic3d_AspectFillArea3d ( const Aspect_InteriorStyle  theInterior,
const Quantity_Color theInteriorColor,
const Quantity_Color theEdgeColor,
const Aspect_TypeOfLine  theEdgeLineType,
const Standard_Real  theEdgeWidth,
const Graphic3d_MaterialAspect theFrontMaterial,
const Graphic3d_MaterialAspect theBackMaterial 
)

Creates a context table for fill area primitives defined with the specified values. Display of back-facing filled polygons. No distinction between external and internal faces of FillAreas. The edges are not drawn. Polygon offset parameters: mode = Aspect_POM_None, factor = 1., units = 0.

Member Function Documentation

void Graphic3d_AspectFillArea3d::AllowBackFace ( )
inline

Allows the display of back-facing filled polygons.

bool Graphic3d_AspectFillArea3d::BackFace ( ) const
inline

Returns true if back faces should be suppressed (true by default).

const Quantity_Color& Graphic3d_AspectFillArea3d::BackInteriorColor ( ) const
inline

Return back interior color.

const Quantity_ColorRGBA& Graphic3d_AspectFillArea3d::BackInteriorColorRGBA ( ) const
inline

Return back interior color.

const Graphic3d_MaterialAspect& Graphic3d_AspectFillArea3d::BackMaterial ( ) const
inline

Returns the surface material of internal faces.

bool Graphic3d_AspectFillArea3d::Distinguish ( ) const
inline

Returns true if material properties should be distinguished for back and front faces (false by default).

bool Graphic3d_AspectFillArea3d::Edge ( ) const
inline

Returns true if edges should be drawn.

const Quantity_Color& Graphic3d_AspectFillArea3d::EdgeColor ( ) const
inline

Return color of edges.

const Quantity_ColorRGBA& Graphic3d_AspectFillArea3d::EdgeColorRGBA ( ) const
inline

Return color of edges.

Aspect_TypeOfLine Graphic3d_AspectFillArea3d::EdgeLineType ( ) const
inline

Return edges line type.

Standard_ShortReal Graphic3d_AspectFillArea3d::EdgeWidth ( ) const
inline

Return width for edges in pixels.

const Graphic3d_MaterialAspect& Graphic3d_AspectFillArea3d::FrontMaterial ( ) const
inline

Returns the surface material of external faces.

Aspect_HatchStyle Graphic3d_AspectFillArea3d::HatchStyle ( ) const
inline

Returns the hatch type used when InteriorStyle is IS_HATCH.

const Quantity_Color& Graphic3d_AspectFillArea3d::InteriorColor ( ) const
inline

Return interior color.

const Quantity_ColorRGBA& Graphic3d_AspectFillArea3d::InteriorColorRGBA ( ) const
inline

Return interior color.

Aspect_InteriorStyle Graphic3d_AspectFillArea3d::InteriorStyle ( ) const
inline

Return interior rendering style (Aspect_IS_EMPTY by default, which means nothing will be rendered!).

const Graphic3d_PolygonOffset& Graphic3d_AspectFillArea3d::PolygonOffset ( ) const
inline

Returns current polygon offsets settings.

void Graphic3d_AspectFillArea3d::PolygonOffsets ( Standard_Integer theMode,
Standard_ShortReal theFactor,
Standard_ShortReal theUnits 
) const
inline

Returns current polygon offsets settings.

void Graphic3d_AspectFillArea3d::SetBackInteriorColor ( const Quantity_Color theColor)
inline

Modifies the color of the interior of the back face.

void Graphic3d_AspectFillArea3d::SetBackMaterial ( const Graphic3d_MaterialAspect theMaterial)
inline

Modifies the surface material of internal faces.

void Graphic3d_AspectFillArea3d::SetDistinguish ( bool  toDistinguish)
inline

Set material distinction between front and back faces.

void Graphic3d_AspectFillArea3d::SetDistinguishOff ( )
inline

Forbids material distinction between front and back faces.

void Graphic3d_AspectFillArea3d::SetDistinguishOn ( )
inline

Allows material distinction between front and back faces.

void Graphic3d_AspectFillArea3d::SetDrawEdges ( bool  theToDraw)
inline

Set if edges should be drawn or not.

void Graphic3d_AspectFillArea3d::SetEdgeColor ( const Quantity_Color theColor)
inline

Modifies the color of the edge of the face.

void Graphic3d_AspectFillArea3d::SetEdgeLineType ( const Aspect_TypeOfLine  theType)
inline

Modifies the edge line type.

void Graphic3d_AspectFillArea3d::SetEdgeOff ( )
inline

The edges of FillAreas are not drawn.

void Graphic3d_AspectFillArea3d::SetEdgeOn ( )
inline

The edges of FillAreas are drawn.

void Graphic3d_AspectFillArea3d::SetEdgeWidth ( const Standard_Real  theWidth)
inline

Modifies the edge thickness Warning: Raises AspectFillAreaDefinitionError if the width is a negative value.

void Graphic3d_AspectFillArea3d::SetFrontMaterial ( const Graphic3d_MaterialAspect theMaterial)
inline

Modifies the surface material of external faces.

void Graphic3d_AspectFillArea3d::SetHatchStyle ( const Aspect_HatchStyle  theStyle)
inline

Modifies the hatch type used when InteriorStyle is IS_HATCH.

void Graphic3d_AspectFillArea3d::SetInteriorColor ( const Quantity_Color theColor)
inline

Modifies the color of the interior of the face.

void Graphic3d_AspectFillArea3d::SetInteriorStyle ( const Aspect_InteriorStyle  theStyle)
inline

Modifies the interior type used for rendering.

void Graphic3d_AspectFillArea3d::SetPolygonOffsets ( const Standard_Integer  theMode,
const Standard_ShortReal  theFactor = 1.0f,
const Standard_ShortReal  theUnits = 0.0f 
)
inline

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)

Default settings for OCC 3D viewer: mode = Aspect_POM_Fill, factor = 1., units = 0.

Negative offset values move polygons closer to the viewport, while positive values shift polygons away. Consult OpenGL reference for details (glPolygonOffset function description).

void Graphic3d_AspectFillArea3d::SetShaderProgram ( const Handle< Graphic3d_ShaderProgram > &  theProgram)
inline

Sets up OpenGL/GLSL shader program.

void Graphic3d_AspectFillArea3d::SetSuppressBackFaces ( bool  theToSuppress)
inline

Assign back faces culling flag.

void Graphic3d_AspectFillArea3d::SetTextureMap ( const Handle< Graphic3d_TextureMap > &  theTexture)
inline

Assign texture to be mapped. See also SetTextureMap() to actually activate texture mapping.

void Graphic3d_AspectFillArea3d::SetTextureMapOff ( )
inline

Disable texture mapping.

void Graphic3d_AspectFillArea3d::SetTextureMapOn ( )
inline

Enable texture mapping (has no effect if texture is not set).

const Handle< Graphic3d_ShaderProgram >& Graphic3d_AspectFillArea3d::ShaderProgram ( ) const
inline

Return shader program.

Graphic3d_AspectFillArea3d::Standard_DEPRECATED ( "Deprecated method Values() should be replaced by individual property getters"  )

Returns the current values.

Graphic3d_AspectFillArea3d::Standard_DEPRECATED ( "Deprecated method Values() should be replaced by individual property getters"  )

Returns the current values.

void Graphic3d_AspectFillArea3d::SuppressBackFace ( )
inline

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.

const Handle< Graphic3d_TextureMap >& Graphic3d_AspectFillArea3d::TextureMap ( ) const
inline

Return texture to be mapped.

bool Graphic3d_AspectFillArea3d::TextureMapState ( ) const
inline

Return true if texture mapping is enabled (false by default).

bool Graphic3d_AspectFillArea3d::ToDrawEdges ( ) const
inline

Returns true if edges should be drawn (false by default).

bool Graphic3d_AspectFillArea3d::ToMapTexture ( ) const
inline

Return true if texture mapping is enabled (false by default).

bool Graphic3d_AspectFillArea3d::ToSuppressBackFaces ( ) const
inline

Returns true if back faces should be suppressed (true by default).

Field Documentation

Initial value:
{
theStyle = myInteriorStyle
Initial value:
{
theStyle = myInteriorStyle
Quantity_ColorRGBA Graphic3d_AspectFillArea3d::myBackInteriorColor
protected
Graphic3d_MaterialAspect Graphic3d_AspectFillArea3d::myBackMaterial
protected
Quantity_ColorRGBA Graphic3d_AspectFillArea3d::myEdgeColor
protected
Aspect_TypeOfLine Graphic3d_AspectFillArea3d::myEdgeType
protected
Standard_ShortReal Graphic3d_AspectFillArea3d::myEdgeWidth
protected
Graphic3d_MaterialAspect Graphic3d_AspectFillArea3d::myFrontMaterial
protected
Aspect_HatchStyle Graphic3d_AspectFillArea3d::myHatchStyle
protected
Quantity_ColorRGBA Graphic3d_AspectFillArea3d::myInteriorColor
protected
Aspect_InteriorStyle Graphic3d_AspectFillArea3d::myInteriorStyle
protected
Graphic3d_PolygonOffset Graphic3d_AspectFillArea3d::myPolygonOffset
protected
Handle< Graphic3d_ShaderProgram > Graphic3d_AspectFillArea3d::myProgram
protected
Handle< Graphic3d_TextureMap > Graphic3d_AspectFillArea3d::myTextureMap
protected
bool Graphic3d_AspectFillArea3d::myToDistinguishMaterials
protected
bool Graphic3d_AspectFillArea3d::myToDrawEdges
protected
bool Graphic3d_AspectFillArea3d::myToMapTexture
protected
bool Graphic3d_AspectFillArea3d::myToSuppressBackFaces
protected
Quantity_Color Quantity_Color& Graphic3d_AspectFillArea3d::theBackIntColor
Graphic3d_AspectFillArea3d::theBackIntColor = myBackInteriorColor.GetRGB()
Quantity_Color Quantity_Color& Graphic3d_AspectFillArea3d::theEdgeColor
Graphic3d_AspectFillArea3d::theEdgeColor = myEdgeColor.GetRGB()
Quantity_Color Quantity_Color Quantity_Color& Graphic3d_AspectFillArea3d::theEdgeColor
Quantity_Color & Graphic3d_AspectFillArea3d::theIntColor
Graphic3d_AspectFillArea3d::theIntColor = myInteriorColor.GetRGB()
Quantity_Color Quantity_Color Aspect_TypeOfLine& Graphic3d_AspectFillArea3d::theType
Graphic3d_AspectFillArea3d::theType = myEdgeType
Quantity_Color Quantity_Color Quantity_Color Aspect_TypeOfLine& Graphic3d_AspectFillArea3d::theType
Graphic3d_AspectFillArea3d::theWidth = myEdgeWidth

The documentation for this class was generated from the following file: