Open CASCADE Technology  6.9.0
Public Member Functions | Protected Attributes

Graphic3d_AspectMarker3d Class Reference

Creates and updates an attribute group for marker type primitives. This group contains the type of marker, its colour, 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 Image_PixMap_Handle &theTextureImage)
 Creates a context table for marker primitives defined with the specified values. 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)
 
void SetShaderProgram (const Handle< Graphic3d_ShaderProgram > &theProgram)
 Sets up OpenGL/GLSL shader program. More...
 
const Handle
< Graphic3d_ShaderProgram > & 
ShaderProgram () const
 
- Public Member Functions inherited from Aspect_AspectMarker
void SetColor (const Quantity_Color &AColor)
 Modifies the colour of <me>. More...
 
void SetScale (const Standard_Real AScale)
 Modifies the scale factor of <me>. 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 SetType (const Aspect_TypeOfMarker AType)
 Modifies the type of marker <me>. More...
 
void Values (Quantity_Color &AColor, Aspect_TypeOfMarker &AType, Standard_Real &AScale) const
 Returns the current values of the group <me>. More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. 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 const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const 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 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...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Protected Attributes

Handle< Graphic3d_MarkerImagemyMarkerImage
 

Additional Inherited Members

- Protected Member Functions inherited from Aspect_AspectMarker
 Aspect_AspectMarker ()
 Initialise the constructor for Graphic3d_AspectMarker3d. More...
 
 Aspect_AspectMarker (const Quantity_Color &AColor, const Aspect_TypeOfMarker AType, const Standard_Real AScale)
 Initialise the values for the constructor of Graphic3d_AspectMarker3d. Warning: Raises AspectMarkerDefinitionError if the scale is a negative value. More...
 

Detailed Description

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

Constructor & Destructor Documentation

Graphic3d_AspectMarker3d::Graphic3d_AspectMarker3d ( )

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

Marker type : TOM_X Colour : YELLOW Scale factor: 1.0

Graphic3d_AspectMarker3d::Graphic3d_AspectMarker3d ( const Aspect_TypeOfMarker  theType,
const Quantity_Color theColor,
const Standard_Real  theScale 
)
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::Graphic3d_AspectMarker3d ( const Image_PixMap_Handle theTextureImage)

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

Member Function Documentation

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

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

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

Returns marker's texture size.

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

Set marker's image texture.

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

Sets up OpenGL/GLSL shader program.

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

Field Documentation

Handle< Graphic3d_MarkerImage > Graphic3d_AspectMarker3d::myMarkerImage
protected

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