OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Draw_Box Class Reference

    a 3d box More...

    #include <Draw_Box.hxx>

    Inheritance diagram for Draw_Box:

    Public Member Functions

     Draw_Box (const Bnd_OBB &theOBB, const Draw_Color &theColor)
     Constructor.
    void DrawOn (Draw_Display &theDis) const override
     Draws myOBB.
    Public Member Functions inherited from Draw_Drawable3D
    virtual bool PickReject (const double X, const double Y, const double Prec) const
     Returns True if the pick is outside the box.
    virtual occ::handle< Draw_Drawable3DCopy () const
     For variable copy.
    virtual void Dump (Standard_OStream &S) const
     For variable dump.
    virtual void Save (Standard_OStream &theStream) const
     Save drawable into stream; default implementation raises Standard_NotImplemented exception.
    virtual void Whatis (Draw_Interpretor &I) const
     For variable whatis command. Set as a result the type of the variable.
    virtual bool Is3D () const
     Is a 3D object. (Default True).
    virtual bool IsDisplayable () const
     Return TRUE if object can be displayed.
    void SetBounds (const double theXMin, const double theXMax, const double theYMin, const double theYMax)
    void Bounds (double &theXMin, double &theXMax, double &theYMin, double &theYMax) const
    bool Visible () const
    void Visible (const bool V)
    bool Protected () const
    void Protected (const bool P)
    const char * Name () const
    virtual void Name (const char *const N)
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool 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.
    bool IsKind (const char *const 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_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.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Protected Member Functions

    void ToWCS (const double theX, const double theY, const double theZ, gp_Pnt &theP) const
     Converts the point (theX, theY, theZ) in local coordinate system to WCS.
    void MoveX (const double theShift, gp_Pnt &thePt) const
     Moves the point thePt along X-direction of myOBB on the distance theShift.
    void MoveY (const double theShift, gp_Pnt &thePt) const
     Moves the point thePt along Y-direction of myOBB on the distance theShift.
    void MoveZ (const double theShift, gp_Pnt &thePt) const
     Moves the point thePt along Z-direction of myOBB on the distance theShift.
    Protected Member Functions inherited from Draw_Drawable3D
     Draw_Drawable3D ()

    Additional Inherited Members

    Public Types inherited from Draw_Drawable3D
    typedef occ::handle< Draw_Drawable3D >(* FactoryFunction_t) (Standard_IStream &theStream)
     Function type for restoring drawable from stream.
    typedef void base_type
     Returns a type descriptor about this object.
    Static Public Member Functions inherited from Draw_Drawable3D
    static void RegisterFactory (const char *const theType, const FactoryFunction_t &theFactory)
     Register factory for restoring drawable from stream (opposite to Draw_Drawable3D::Save()).
    static occ::handle< Draw_Drawable3DRestore (const char *const theType, Standard_IStream &theStream)
     Restore drawable from stream (opposite to Draw_Drawable3D::Save()).
    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 3d box

    Constructor & Destructor Documentation

    ◆ Draw_Box()

    Draw_Box::Draw_Box ( const Bnd_OBB & theOBB,
    const Draw_Color & theColor )

    Constructor.

    Member Function Documentation

    ◆ DrawOn()

    void Draw_Box::DrawOn ( Draw_Display & theDis) const
    overridevirtual

    Draws myOBB.

    Implements Draw_Drawable3D.

    ◆ MoveX()

    void Draw_Box::MoveX ( const double theShift,
    gp_Pnt & thePt ) const
    protected

    Moves the point thePt along X-direction of myOBB on the distance theShift.

    ◆ MoveY()

    void Draw_Box::MoveY ( const double theShift,
    gp_Pnt & thePt ) const
    protected

    Moves the point thePt along Y-direction of myOBB on the distance theShift.

    ◆ MoveZ()

    void Draw_Box::MoveZ ( const double theShift,
    gp_Pnt & thePt ) const
    protected

    Moves the point thePt along Z-direction of myOBB on the distance theShift.

    ◆ ToWCS()

    void Draw_Box::ToWCS ( const double theX,
    const double theY,
    const double theZ,
    gp_Pnt & theP ) const
    protected

    Converts the point (theX, theY, theZ) in local coordinate system to WCS.


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