Open CASCADE Technology  7.3.0
Public Member Functions | Data Fields | Protected Attributes
Graphic3d_AspectMarker3d Class Reference

Creates and updates an attribute group for marker type primitives. This group contains the type of marker, its color, and its scale factor. More...

#include <Graphic3d_AspectMarker3d.hxx>

Inheritance diagram for Graphic3d_AspectMarker3d:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_AspectMarker3d ()
 Creates a context table for marker primitives defined with the following default values: More...
 
 Graphic3d_AspectMarker3d (const Aspect_TypeOfMarker theType, const Quantity_Color &theColor, const Standard_Real theScale)
 
 Graphic3d_AspectMarker3d (const Quantity_Color &theColor, const Standard_Integer theWidth, const Standard_Integer theHeight, const Handle< TColStd_HArray1OfByte > &theTextureBitmap)
 Creates a context table for marker primitives defined with the specified values. More...
 
 Graphic3d_AspectMarker3d (const Handle< Image_PixMap > &theTextureImage)
 Creates a context table for marker primitives defined with the specified values. 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...
 
Standard_ShortReal Scale () const
 Return scale factor. More...
 
void SetScale (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 AspectMarkerDefinitionError if the scale is a negative value. More...
 
void SetScale (const Standard_Real theScale)
 Assign scale factor. More...
 
Aspect_TypeOfMarker Type () const
 Return marker type. More...
 
void SetType (const Aspect_TypeOfMarker theType)
 Modifies the type of marker. More...
 
void GetTextureSize (Standard_Integer &theWidth, Standard_Integer &theHeight) const
 Returns marker's texture size. More...
 
const Handle< Graphic3d_MarkerImage > & GetMarkerImage () 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...
 
void SetBitMap (const Standard_Integer theWidth, const Standard_Integer theHeight, const Handle< TColStd_HArray1OfByte > &theTexture)
 
const Handle< Graphic3d_ShaderProgram > & ShaderProgram () const
 Return the program. More...
 
void SetShaderProgram (const Handle< Graphic3d_ShaderProgram > &theProgram)
 Sets up OpenGL/GLSL shader program. 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_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

Aspect_TypeOfMarkertheType
 
Aspect_TypeOfMarker Standard_Real &theScale const
 
 theType = myType
 
 theScale = myScale
 

Protected Attributes

Handle< Graphic3d_ShaderProgrammyProgram
 
Handle< Graphic3d_MarkerImagemyMarkerImage
 
Quantity_ColorRGBA myColor
 
Aspect_TypeOfMarker myType
 
Standard_ShortReal myScale
 

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 an attribute group for marker type primitives. This group contains the type of marker, its color, and its scale factor.

Constructor & Destructor Documentation

◆ Graphic3d_AspectMarker3d() [1/4]

Graphic3d_AspectMarker3d::Graphic3d_AspectMarker3d ( )

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

Marker type : TOM_X Color : YELLOW Scale factor: 1.0

◆ Graphic3d_AspectMarker3d() [2/4]

Graphic3d_AspectMarker3d::Graphic3d_AspectMarker3d ( const Aspect_TypeOfMarker  theType,
const Quantity_Color theColor,
const Standard_Real  theScale 
)

◆ Graphic3d_AspectMarker3d() [3/4]

Graphic3d_AspectMarker3d::Graphic3d_AspectMarker3d ( const Quantity_Color theColor,
const Standard_Integer  theWidth,
const Standard_Integer  theHeight,
const Handle< TColStd_HArray1OfByte > &  theTextureBitmap 
)

Creates a context table for marker primitives defined with the specified values.

◆ Graphic3d_AspectMarker3d() [4/4]

Graphic3d_AspectMarker3d::Graphic3d_AspectMarker3d ( const Handle< Image_PixMap > &  theTextureImage)

Creates a context table for marker primitives defined with the specified values.

Member Function Documentation

◆ Color()

const Quantity_Color& Graphic3d_AspectMarker3d::Color ( ) const
inline

Return the color.

◆ ColorRGBA()

const Quantity_ColorRGBA& Graphic3d_AspectMarker3d::ColorRGBA ( ) const
inline

Return color.

◆ GetMarkerImage()

const Handle< Graphic3d_MarkerImage >& Graphic3d_AspectMarker3d::GetMarkerImage ( ) const
inline

Returns marker's image texture. Could be null handle if marker aspect has been initialized as default type of marker.

◆ GetTextureSize()

void Graphic3d_AspectMarker3d::GetTextureSize ( Standard_Integer theWidth,
Standard_Integer theHeight 
) const

Returns marker's texture size.

◆ Scale()

Standard_ShortReal Graphic3d_AspectMarker3d::Scale ( ) const
inline

Return scale factor.

◆ SetBitMap()

void Graphic3d_AspectMarker3d::SetBitMap ( const Standard_Integer  theWidth,
const Standard_Integer  theHeight,
const Handle< TColStd_HArray1OfByte > &  theTexture 
)

◆ SetColor()

void Graphic3d_AspectMarker3d::SetColor ( const Quantity_Color theColor)
inline

Modifies the color.

◆ SetMarkerImage()

void Graphic3d_AspectMarker3d::SetMarkerImage ( const Handle< Graphic3d_MarkerImage > &  theImage)
inline

Set marker's image texture.

◆ SetScale() [1/2]

void Graphic3d_AspectMarker3d::SetScale ( const Standard_ShortReal  theScale)
inline

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 AspectMarkerDefinitionError if the scale is a negative value.

◆ SetScale() [2/2]

void Graphic3d_AspectMarker3d::SetScale ( const Standard_Real  theScale)
inline

Assign scale factor.

◆ SetShaderProgram()

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

Sets up OpenGL/GLSL shader program.

◆ SetType()

void Graphic3d_AspectMarker3d::SetType ( const Aspect_TypeOfMarker  theType)
inline

Modifies the type of marker.

◆ ShaderProgram()

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

Return the program.

◆ Standard_DEPRECATED()

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

Returns the current values of the group.

◆ Type()

Aspect_TypeOfMarker Graphic3d_AspectMarker3d::Type ( ) const
inline

Return marker type.

Field Documentation

◆ const

Aspect_TypeOfMarker Standard_Real& theScale Graphic3d_AspectMarker3d::const
Initial value:
{
theColor = myColor.GetRGB()

◆ myColor

Quantity_ColorRGBA Graphic3d_AspectMarker3d::myColor
protected

◆ myMarkerImage

Handle< Graphic3d_MarkerImage > Graphic3d_AspectMarker3d::myMarkerImage
protected

◆ myProgram

Handle< Graphic3d_ShaderProgram > Graphic3d_AspectMarker3d::myProgram
protected

◆ myScale

Standard_ShortReal Graphic3d_AspectMarker3d::myScale
protected

◆ myType

Aspect_TypeOfMarker Graphic3d_AspectMarker3d::myType
protected

◆ theScale

Graphic3d_AspectMarker3d::theScale = myScale

◆ theType [1/2]

Aspect_TypeOfMarker& Graphic3d_AspectMarker3d::theType

◆ theType [2/2]

Graphic3d_AspectMarker3d::theType = myType

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