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:

[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, const Aspect_TypeOfLine theType, const 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...

const Quantity_ColorRGBA &	ColorRGBA () const
	Return color. More...

const Quantity_Color &	Color () const
	Return color. More...

void	SetColor (const Quantity_Color &theColor)
	Modifies the color. 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 AspectLineDefinitionError if the width is a negative value. More...

void	SetWidth (const Standard_ShortReal theWidth)
	Modifies the line thickness. Warning: Raises AspectLineDefinitionError if the width is a negative value. 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...

bool	IsEqual (const Graphic3d_AspectLine3d &theOther)
	Check for equality with another line aspect. More...

	Standard_DEPRECATED ("Deprecated method Values() should be replaced by individual property getters") void Values(Quantity_Color &theColor
	Returns the current values of the group. More...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (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_Transient *	This () 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
Aspect_TypeOfLine &	theType

Aspect_TypeOfLine Standard_Real &theWidth	const

	theType = myType

	theWidth = myWidth

Protected Attributes
Handle< Graphic3d_ShaderProgram >	myProgram

Quantity_ColorRGBA	myColor

Aspect_TypeOfLine	myType

Standard_ShortReal	myWidth

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

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,
		const Aspect_TypeOfLine	theType,
		const 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

◆ Color()

const Quantity_Color& Graphic3d_AspectLine3d::Color ( ) const

inline

Return color.

◆ ColorRGBA()

const Quantity_ColorRGBA& Graphic3d_AspectLine3d::ColorRGBA ( ) const

inline

Return color.

◆ IsEqual()

bool Graphic3d_AspectLine3d::IsEqual ( const Graphic3d_AspectLine3d & theOther )

inline

Check for equality with another line aspect.

◆ SetColor()

void Graphic3d_AspectLine3d::SetColor ( const Quantity_Color & theColor )

inline

Modifies the color.

◆ SetShaderProgram()

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

inline

Sets up OpenGL/GLSL shader program.

◆ 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 AspectLineDefinitionError if the width is a negative value.

◆ SetWidth() [2/2]

void Graphic3d_AspectLine3d::SetWidth ( const Standard_ShortReal theWidth )

inline

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

◆ ShaderProgram()

const Handle< Graphic3d_ShaderProgram >& Graphic3d_AspectLine3d::ShaderProgram ( ) const

inline

Return shader program.

◆ Standard_DEPRECATED()

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

Returns the current values of the group.

◆ Type()

Aspect_TypeOfLine Graphic3d_AspectLine3d::Type ( ) const

inline

Return line type.

◆ Width()

Standard_ShortReal Graphic3d_AspectLine3d::Width ( ) const

inline

Return line width.

Field Documentation

◆ const

Aspect_TypeOfLine Standard_Real& theWidth Graphic3d_AspectLine3d::const

Initial value:

{

theColor = myColor.GetRGB()

◆ myColor

Quantity_ColorRGBA Graphic3d_AspectLine3d::myColor

protected

◆ myProgram

Handle< Graphic3d_ShaderProgram > Graphic3d_AspectLine3d::myProgram

protected

◆ myType

Aspect_TypeOfLine Graphic3d_AspectLine3d::myType

protected

◆ myWidth

Standard_ShortReal Graphic3d_AspectLine3d::myWidth

protected

◆ theType [1/2]

Aspect_TypeOfLine& Graphic3d_AspectLine3d::theType

◆ theType [2/2]

Graphic3d_AspectLine3d::theType = myType

◆ theWidth

Graphic3d_AspectLine3d::theWidth = myWidth

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

Graphic3d_AspectLine3d.hxx

Graphic3d_AspectLine3d Class Reference

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graphic3d_AspectLine3d() [1/2]

◆ Graphic3d_AspectLine3d() [2/2]

Member Function Documentation

◆ Color()

◆ ColorRGBA()

◆ IsEqual()

◆ SetColor()

◆ SetShaderProgram()

◆ SetType()

◆ SetWidth() [1/2]

◆ SetWidth() [2/2]

◆ ShaderProgram()

◆ Standard_DEPRECATED()

◆ Type()

◆ Width()

Field Documentation

◆ const

◆ myColor

◆ myProgram

◆ myType

◆ myWidth

◆ theType [1/2]

◆ theType [2/2]

◆ theWidth