Open CASCADE Technology  7.3.1.dev
Public Member Functions
Graphic3d_AspectLine3d Class Reference

Creates and updates a group of attributes for 3d line primitives. This group contains the color, the type of line, and its thickness. More...

#include <Graphic3d_AspectLine3d.hxx>

Inheritance diagram for Graphic3d_AspectLine3d:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_AspectLine3d ()
 Creates a context table for line primitives defined with the following default values: More...
 
 Graphic3d_AspectLine3d (const Quantity_Color &theColor, Aspect_TypeOfLine theType, Standard_Real theWidth)
 Creates a context table for line primitives defined with the specified values. Warning: theWidth is the "line width scale factor". The nominal line width is 1 pixel. The width of the line is determined by applying the line width scale factor to this nominal line width. The supported line widths vary by 1-pixel units. More...
 
Aspect_TypeOfLine Type () const
 Return line type. More...
 
void SetType (const Aspect_TypeOfLine theType)
 Modifies the type of line. More...
 
Standard_ShortReal Width () const
 Return line width. More...
 
void SetWidth (const Standard_Real theWidth)
 Modifies the line thickness. Warning: Raises Standard_OutOfRange if the width is a negative value. More...
 
void SetWidth (Standard_ShortReal theWidth)
 Modifies the line thickness. Warning: Raises Standard_OutOfRange if the width is a negative value. More...
 
- Public Member Functions inherited from Graphic3d_Aspects
 Graphic3d_Aspects ()
 Creates a context table for drawing primitives defined with the following default values: More...
 
Aspect_InteriorStyle InteriorStyle () const
 Return interior rendering style; Aspect_IS_SOLID by default. More...
 
void SetInteriorStyle (const Aspect_InteriorStyle theStyle)
 Modifies the interior type used for rendering. More...
 
Graphic3d_TypeOfShadingModel ShadingModel () const
 Returns shading model; Graphic3d_TOSM_DEFAULT by default. Graphic3d_TOSM_DEFAULT means that Shading Model set as default for entire Viewer will be used. More...
 
void SetShadingModel (const Graphic3d_TypeOfShadingModel theShadingModel)
 Sets shading model. More...
 
Graphic3d_AlphaMode AlphaMode () const
 Returns the way how alpha value should be treated (Graphic3d_AlphaMode_BlendAuto by default, for backward compatibility). More...
 
Standard_ShortReal AlphaCutoff () const
 Returns alpha cutoff threshold, for discarding fragments within Graphic3d_AlphaMode_Mask mode (0.5 by default). If the alpha value is greater than or equal to this value then it is rendered as fully opaque, otherwise, it is rendered as fully transparent. More...
 
void SetAlphaMode (Graphic3d_AlphaMode theMode, Standard_ShortReal theAlphaCutoff=0.5f)
 Defines the way how alpha value should be treated. More...
 
const Quantity_ColorRGBAColorRGBA () const
 Return color. More...
 
const Quantity_ColorColor () const
 Return the color. More...
 
void SetColor (const Quantity_Color &theColor)
 Modifies the color. 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...
 
void SetInteriorColor (const Quantity_ColorRGBA &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...
 
void SetBackInteriorColor (const Quantity_ColorRGBA &theColor)
 Modifies the color of the interior of the back face. More...
 
const Graphic3d_MaterialAspectFrontMaterial () const
 Returns the surface material of external faces. More...
 
Graphic3d_MaterialAspectChangeFrontMaterial ()
 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...
 
Graphic3d_MaterialAspectChangeBackMaterial ()
 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_TextureSet > & TextureSet () const
 Return texture array to be mapped. More...
 
void SetTextureSet (const Handle< Graphic3d_TextureSet > &theTextures)
 Setup texture array to be mapped. More...
 
Handle< Graphic3d_TextureMapTextureMap () const
 Return texture to be mapped. More...
 
void SetTextureMap (const Handle< Graphic3d_TextureMap > &theTexture)
 Assign texture to be mapped. See also SetTextureMapOn() 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 (bool theToMap)
 Enable or disable texture mapping (has no effect if texture is not set). 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 SetPolygonOffset (const Graphic3d_PolygonOffset &theOffset)
 Sets 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...
 
Aspect_TypeOfLine LineType () const
 Return line type; Aspect_TOL_SOLID by default. More...
 
void SetLineType (Aspect_TypeOfLine theType)
 Modifies the line type. More...
 
Standard_ShortReal LineWidth () const
 Return width for edges in pixels; 1.0 by default. More...
 
void SetLineWidth (Standard_ShortReal theWidth)
 Modifies the line thickness Warning: Raises Standard_OutOfRange if the width is a negative value. More...
 
Aspect_TypeOfMarker MarkerType () const
 Return marker type; Aspect_TOM_POINT by default. More...
 
void SetMarkerType (Aspect_TypeOfMarker theType)
 Modifies the type of marker. More...
 
Standard_ShortReal MarkerScale () const
 Return marker scale factor; 1.0 by default. More...
 
void SetMarkerScale (const Standard_ShortReal theScale)
 Modifies the scale factor. Marker type Aspect_TOM_POINT is not affected by the marker size scale factor. It is always the smallest displayable dot. Warning: Raises Standard_OutOfRange if the scale is a negative value. More...
 
const Handle< Graphic3d_MarkerImage > & MarkerImage () const
 Returns marker's image texture. Could be null handle if marker aspect has been initialized as default type of marker. More...
 
void SetMarkerImage (const Handle< Graphic3d_MarkerImage > &theImage)
 Set marker's image texture. More...
 
bool IsMarkerSprite () const
 Returns TRUE if marker should be drawn using marker sprite (either user-provided or generated). More...
 
const Handle< TCollection_HAsciiString > & TextFont () const
 Returns the font; NULL string by default. More...
 
void SetTextFont (const Handle< TCollection_HAsciiString > &theFont)
 Modifies the font. More...
 
Font_FontAspect TextFontAspect () const
 Returns text FontAspect. More...
 
void SetTextFontAspect (Font_FontAspect theFontAspect)
 Turns usage of Aspect text. More...
 
Aspect_TypeOfDisplayText TextDisplayType () const
 Returns display type; Aspect_TODT_NORMAL by default. More...
 
void SetTextDisplayType (Aspect_TypeOfDisplayText theType)
 Sets display type. More...
 
const Quantity_ColorRGBAColorSubTitleRGBA () const
 Returns text background/shadow color; equals to EdgeColor() property. More...
 
const Quantity_ColorColorSubTitle () const
 Return text background/shadow color; equals to EdgeColor() property. More...
 
void SetColorSubTitle (const Quantity_Color &theColor)
 Modifies text background/shadow color; equals to EdgeColor() property. More...
 
void SetColorSubTitle (const Quantity_ColorRGBA &theColor)
 Modifies text background/shadow color; equals to EdgeColor() property. More...
 
bool IsTextZoomable () const
 Returns TRUE when the Text Zoomable is on. More...
 
void SetTextZoomable (bool theFlag)
 Turns usage of text zoomable on/off. More...
 
Aspect_TypeOfStyleText TextStyle () const
 Returns the text style; Aspect_TOST_NORMAL by default. More...
 
void SetTextStyle (Aspect_TypeOfStyleText theStyle)
 Modifies the style of the text. More...
 
Standard_ShortReal TextAngle () const
 Returns Angle of degree. More...
 
void SetTextAngle (Standard_ShortReal theAngle)
 Turns usage of text rotated. More...
 
bool ToDrawEdges () const
 Returns true if mesh edges should be drawn (false by default). More...
 
void SetDrawEdges (bool theToDraw)
 Set if mesh edges should be drawn or not. 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...
 
void SetEdgeColor (const Quantity_ColorRGBA &theColor)
 Modifies the color of the edge of the face. More...
 
Aspect_TypeOfLine EdgeLineType () const
 Return edges line type (same as LineType()). More...
 
void SetEdgeLineType (Aspect_TypeOfLine theType)
 Modifies the edge line type (same as SetLineType()) More...
 
Standard_ShortReal EdgeWidth () const
 Return width for edges in pixels (same as LineWidth()). More...
 
void SetEdgeWidth (Standard_Real theWidth)
 Modifies the edge thickness (same as SetLineWidth()) More...
 
bool ToSkipFirstEdge () const
 Returns TRUE if drawing element edges should discard first edge in triangle; FALSE by default. Graphics hardware works mostly with triangles, so that wireframe presentation will draw triangle edges by default. This flag allows rendering wireframe presentation of quad-only array split into triangles. For this, quads should be split in specific order, so that the quad diagonal (to be NOT rendered) goes first: 1---—2 / / Triangle #1: 2-0-1; Triangle #2: 0-2-3 0---—3. More...
 
void SetSkipFirstEdge (bool theToSkipFirstEdge)
 Set skip first triangle edge flag for drawing wireframe presentation of quads array split into triangles. More...
 
bool ToDrawSilhouette () const
 Returns TRUE if silhouette (outline) should be drawn (with edge color and width); FALSE by default. More...
 
void SetDrawSilhouette (bool theToDraw)
 Enables/disables drawing silhouette (outline). More...
 
const Handle< Graphic3d_HatchStyle > & HatchStyle () const
 Returns the hatch type used when InteriorStyle is IS_HATCH. More...
 
void SetHatchStyle (const Handle< Graphic3d_HatchStyle > &theStyle)
 Modifies 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...
 
bool IsEqual (const Graphic3d_Aspects &theOther)
 Check for equality with another aspects. 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...
 

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...
 
- Protected Attributes inherited from Graphic3d_Aspects
Handle< Graphic3d_ShaderProgrammyProgram
 Returns true if mesh edges should be drawn (false by default). More...
 
Handle< Graphic3d_TextureSetmyTextureSet
 Returns true if mesh edges should be drawn (false by default). More...
 
Handle< Graphic3d_MarkerImagemyMarkerImage
 Returns true if mesh edges should be drawn (false by default). More...
 
Handle< Graphic3d_HatchStylemyHatchStyle
 Returns true if mesh edges should be drawn (false by default). More...
 
Handle< TCollection_HAsciiStringmyTextFont
 Returns true if mesh edges should be drawn (false by default). More...
 
Graphic3d_MaterialAspect myFrontMaterial
 Returns true if mesh edges should be drawn (false by default). More...
 
Graphic3d_MaterialAspect myBackMaterial
 Returns true if mesh edges should be drawn (false by default). More...
 
Quantity_ColorRGBA myInteriorColor
 Returns true if mesh edges should be drawn (false by default). More...
 
Quantity_ColorRGBA myBackInteriorColor
 Returns true if mesh edges should be drawn (false by default). More...
 
Quantity_ColorRGBA myEdgeColor
 Returns true if mesh edges should be drawn (false by default). More...
 
Graphic3d_PolygonOffset myPolygonOffset
 Returns true if mesh edges should be drawn (false by default). More...
 
Aspect_InteriorStyle myInteriorStyle
 Returns true if mesh edges should be drawn (false by default). More...
 
Graphic3d_TypeOfShadingModel myShadingModel
 Returns true if mesh edges should be drawn (false by default). More...
 
Graphic3d_AlphaMode myAlphaMode
 Returns true if mesh edges should be drawn (false by default). More...
 
Standard_ShortReal myAlphaCutoff
 Returns true if mesh edges should be drawn (false by default). More...
 
Aspect_TypeOfLine myLineType
 Returns true if mesh edges should be drawn (false by default). More...
 
Standard_ShortReal myLineWidth
 Returns true if mesh edges should be drawn (false by default). More...
 
Aspect_TypeOfMarker myMarkerType
 Returns true if mesh edges should be drawn (false by default). More...
 
Standard_ShortReal myMarkerScale
 Returns true if mesh edges should be drawn (false by default). More...
 
Aspect_TypeOfStyleText myTextStyle
 Returns true if mesh edges should be drawn (false by default). More...
 
Aspect_TypeOfDisplayText myTextDisplayType
 Returns true if mesh edges should be drawn (false by default). More...
 
Font_FontAspect myTextFontAspect
 Returns true if mesh edges should be drawn (false by default). More...
 
Standard_ShortReal myTextAngle
 Returns true if mesh edges should be drawn (false by default). More...
 
bool myToSkipFirstEdge
 Returns true if mesh edges should be drawn (false by default). More...
 
bool myToDistinguishMaterials
 Returns true if mesh edges should be drawn (false by default). More...
 
bool myToDrawEdges
 Returns true if mesh edges should be drawn (false by default). More...
 
bool myToDrawSilhouette
 Returns true if mesh edges should be drawn (false by default). More...
 
bool myToSuppressBackFaces
 Returns true if mesh edges should be drawn (false by default). More...
 
bool myToMapTexture
 Returns true if mesh edges should be drawn (false by default). More...
 
bool myIsTextZoomable
 Returns true if mesh edges should be drawn (false by default). More...
 

Detailed Description

Creates and updates a group of attributes for 3d line primitives. This group contains the color, the type of line, and its thickness.

Constructor & Destructor Documentation

◆ Graphic3d_AspectLine3d() [1/2]

Graphic3d_AspectLine3d::Graphic3d_AspectLine3d ( )

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

Color = Quantity_NOC_YELLOW; Type = Aspect_TOL_SOLID; Width = 1.0;

◆ Graphic3d_AspectLine3d() [2/2]

Graphic3d_AspectLine3d::Graphic3d_AspectLine3d ( const Quantity_Color theColor,
Aspect_TypeOfLine  theType,
Standard_Real  theWidth 
)

Creates a context table for line primitives defined with the specified values. Warning: theWidth is the "line width scale factor". The nominal line width is 1 pixel. The width of the line is determined by applying the line width scale factor to this nominal line width. The supported line widths vary by 1-pixel units.

Member Function Documentation

◆ SetType()

void Graphic3d_AspectLine3d::SetType ( const Aspect_TypeOfLine  theType)
inline

Modifies the type of line.

◆ SetWidth() [1/2]

void Graphic3d_AspectLine3d::SetWidth ( const Standard_Real  theWidth)
inline

Modifies the line thickness. Warning: Raises Standard_OutOfRange if the width is a negative value.

◆ SetWidth() [2/2]

void Graphic3d_AspectLine3d::SetWidth ( Standard_ShortReal  theWidth)
inline

Modifies the line thickness. Warning: Raises Standard_OutOfRange if the width is a negative value.

◆ Type()

Aspect_TypeOfLine Graphic3d_AspectLine3d::Type ( ) const
inline

Return line type.

◆ Width()

Standard_ShortReal Graphic3d_AspectLine3d::Width ( ) const
inline

Return line width.


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