Graphic3d_HatchStyle Class Reference
A class that provides an API to use standard OCCT hatch styles defined in Aspect_HatchStyle enum or to create custom styles from a user-defined bitmap. More...
#include <Graphic3d_HatchStyle.hxx>
Inheritance diagram for Graphic3d_HatchStyle:
Public Member Functions | |
| Graphic3d_HatchStyle (const Handle< Image_PixMap > &thePattern) | |
| Creates a new custom hatch style with the given pattern and unique style id. | |
| Graphic3d_HatchStyle (const Aspect_HatchStyle theType) | |
| Creates a new predefined hatch style with the given id in Aspect_HatchStyle enum. GPU memory for the pattern will not be allocated. | |
| const Standard_Byte * | Pattern () const |
| Returns the pattern of custom hatch style. | |
| Standard_Integer | HatchType () const |
| In case if predefined OCCT style is used, returns index in Aspect_HatchStyle enumeration. If the style is custom, returns unique index of the style. | |
| void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const |
| Dumps the content of me into the stream. | |
 Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
Detailed Description
A class that provides an API to use standard OCCT hatch styles defined in Aspect_HatchStyle enum or to create custom styles from a user-defined bitmap.
Constructor & Destructor Documentation
◆ Graphic3d_HatchStyle() [1/2]
| Graphic3d_HatchStyle::Graphic3d_HatchStyle | ( | const Handle< Image_PixMap > & | thePattern | ) |
Creates a new custom hatch style with the given pattern and unique style id.
- Warning
- Raises a program error if given pattern image is not a valid 32*32 bitmap
◆ Graphic3d_HatchStyle() [2/2]
|
inline |
Creates a new predefined hatch style with the given id in Aspect_HatchStyle enum. GPU memory for the pattern will not be allocated.
Member Function Documentation
◆ DumpJson()
| void Graphic3d_HatchStyle::DumpJson | ( | Standard_OStream & | theOStream, |
| Standard_Integer | theDepth = -1 ) const |
Dumps the content of me into the stream.
◆ HatchType()
|
inline |
In case if predefined OCCT style is used, returns index in Aspect_HatchStyle enumeration. If the style is custom, returns unique index of the style.
◆ Pattern()
| const Standard_Byte * Graphic3d_HatchStyle::Pattern | ( | ) | const |
Returns the pattern of custom hatch style.
The documentation for this class was generated from the following file:
Generated by
1.12.0