Open CASCADE Technology  7.6.0
Public Member Functions | Protected Attributes

Prs3d_PointAspect Class Reference

This class defines attributes for the points The points are drawn using markers, whose size does not depend on the zoom value of the views. More...

#include <Prs3d_PointAspect.hxx>

Inheritance diagram for Prs3d_PointAspect:
Inheritance graph
[legend]

Public Member Functions

 Prs3d_PointAspect (const Aspect_TypeOfMarker theType, const Quantity_Color &theColor, const Standard_Real theScale)
 
 Prs3d_PointAspect (const Quantity_Color &theColor, const Standard_Integer theWidth, const Standard_Integer theHeight, const Handle< TColStd_HArray1OfByte > &theTexture)
 Defines the user defined marker point. More...
 
 Prs3d_PointAspect (const Handle< Graphic3d_AspectMarker3d > &theAspect)
 
void SetColor (const Quantity_Color &theColor)
 defines the color to be used when drawing a point. Default value: Quantity_NOC_YELLOW More...
 
void SetTypeOfMarker (const Aspect_TypeOfMarker theType)
 defines the type of representation to be used when drawing a point. Default value: Aspect_TOM_PLUS More...
 
void SetScale (const Standard_Real theScale)
 defines the size of the marker used when drawing a point. Default value: 1. More...
 
const Handle< Graphic3d_AspectMarker3d > & Aspect () const
 
void SetAspect (const Handle< Graphic3d_AspectMarker3d > &theAspect)
 
void GetTextureSize (Standard_Integer &theWidth, Standard_Integer &theHeight) const
 Returns marker's texture size. More...
 
const Handle< Graphic3d_MarkerImage > & GetTexture () const
 Returns marker's texture. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. 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...
 

Protected Attributes

Handle< Graphic3d_AspectMarker3dmyAspect
 

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 attributes for the points The points are drawn using markers, whose size does not depend on the zoom value of the views.

Constructor & Destructor Documentation

◆ Prs3d_PointAspect() [1/3]

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

◆ Prs3d_PointAspect() [2/3]

Prs3d_PointAspect::Prs3d_PointAspect ( const Quantity_Color theColor,
const Standard_Integer  theWidth,
const Standard_Integer  theHeight,
const Handle< TColStd_HArray1OfByte > &  theTexture 
)

Defines the user defined marker point.

◆ Prs3d_PointAspect() [3/3]

Prs3d_PointAspect::Prs3d_PointAspect ( const Handle< Graphic3d_AspectMarker3d > &  theAspect)
inline

Member Function Documentation

◆ Aspect()

const Handle< Graphic3d_AspectMarker3d >& Prs3d_PointAspect::Aspect ( ) const
inline

◆ DumpJson()

virtual void Prs3d_PointAspect::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

◆ GetTexture()

const Handle< Graphic3d_MarkerImage >& Prs3d_PointAspect::GetTexture ( ) const
inline

Returns marker's texture.

◆ GetTextureSize()

void Prs3d_PointAspect::GetTextureSize ( Standard_Integer theWidth,
Standard_Integer theHeight 
) const
inline

Returns marker's texture size.

◆ SetAspect()

void Prs3d_PointAspect::SetAspect ( const Handle< Graphic3d_AspectMarker3d > &  theAspect)
inline

◆ SetColor()

void Prs3d_PointAspect::SetColor ( const Quantity_Color theColor)
inline

defines the color to be used when drawing a point. Default value: Quantity_NOC_YELLOW

◆ SetScale()

void Prs3d_PointAspect::SetScale ( const Standard_Real  theScale)
inline

defines the size of the marker used when drawing a point. Default value: 1.

◆ SetTypeOfMarker()

void Prs3d_PointAspect::SetTypeOfMarker ( const Aspect_TypeOfMarker  theType)
inline

defines the type of representation to be used when drawing a point. Default value: Aspect_TOM_PLUS

Field Documentation

◆ myAspect

Handle< Graphic3d_AspectMarker3d > Prs3d_PointAspect::myAspect
protected

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