Open CASCADE Technology 7.8.2.dev
DrawTrSurf_Curve Class Reference

This class defines a drawable curve in 3d space. More...

#include <DrawTrSurf_Curve.hxx>

Inheritance diagram for DrawTrSurf_Curve:

Public Member Functions

 DrawTrSurf_Curve (const Handle< Geom_Curve > &C, const Standard_Boolean DispOrigin=Standard_True)
 creates a drawable curve from a curve of package Geom.
 
 DrawTrSurf_Curve (const Handle< Geom_Curve > &C, const Draw_Color &aColor, const Standard_Integer Discret, const Standard_Real Deflection, const Standard_Integer DrawMode, const Standard_Boolean DispOrigin=Standard_True, const Standard_Boolean DispCurvRadius=Standard_False, const Standard_Real RadiusMax=1.0e3, const Standard_Real RatioOfRadius=0.1)
 
virtual void DrawOn (Draw_Display &dis) const override
 this is defined only to tell C++ not to complain about inheriting a pure virtual method.
 
Handle< Geom_CurveGetCurve () const
 
void SetColor (const Draw_Color &theColor)
 
Standard_Boolean DisplayOrigin () const
 
void DisplayOrigin (const Standard_Boolean V)
 
void ShowCurvature ()
 
void ClearCurvature ()
 
void SetRadiusMax (const Standard_Real theRadius)
 
void SetRadiusRatio (const Standard_Real theRatio)
 
Draw_Color Color () const
 
Standard_Real RadiusMax () const
 
Standard_Real RadiusRatio () const
 
virtual Handle< Draw_Drawable3DCopy () const override
 For variable copy.
 
virtual void Dump (Standard_OStream &S) const override
 For variable dump.
 
virtual void Save (Standard_OStream &theStream) const override
 Save drawable into stream.
 
virtual void Whatis (Draw_Interpretor &I) const override
 For variable whatis command. Set as a result the type of the variable.
 
- Public Member Functions inherited from DrawTrSurf_Drawable
void DrawCurve2dOn (Adaptor2d_Curve2d &C, Draw_Display &D) const
 Draw a polygon of the curve on the Display.
 
void DrawCurveOn (Adaptor3d_Curve &C, Draw_Display &D) const
 Draw a polygon of the curve on the Display.
 
void DrawIsoCurveOn (Adaptor3d_IsoCurve &C, const GeomAbs_IsoType T, const Standard_Real P, const Standard_Real F, const Standard_Real L, Draw_Display &D) const
 Load C with the specified iso and Draw a polygon of the curve on the Display.
 
void SetDiscretisation (const Standard_Integer theDiscret)
 
Standard_Integer GetDiscretisation () const
 
void SetDeflection (const Standard_Real theDeflection)
 
Standard_Real GetDeflection () const
 
void SetDrawMode (const Standard_Integer theDrawMode)
 
Standard_Integer GetDrawMode () const
 
- Public Member Functions inherited from Draw_Drawable3D
virtual Standard_Boolean PickReject (const Standard_Real X, const Standard_Real Y, const Standard_Real Prec) const
 Returns True if the pick is outside the box.
 
virtual bool Is3D () const
 Is a 3D object. (Default True).
 
virtual bool IsDisplayable () const
 Return TRUE if object can be displayed.
 
void SetBounds (const Standard_Real theXMin, const Standard_Real theXMax, const Standard_Real theYMin, const Standard_Real theYMax)
 
void Bounds (Standard_Real &theXMin, Standard_Real &theXMax, Standard_Real &theYMin, Standard_Real &theYMax) const
 
Standard_Boolean Visible () const
 
void Visible (const Standard_Boolean V)
 
Standard_Boolean Protected () const
 
void Protected (const Standard_Boolean P)
 
Standard_CString Name () const
 
virtual void Name (const Standard_CString 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 ()
 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_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.
 
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.
 

Protected Attributes

Handle< Geom_Curvecurv
 
Draw_Color look
 
Standard_Boolean disporigin
 
Standard_Boolean dispcurvradius
 
Standard_Real radiusmax
 
Standard_Real radiusratio
 

Additional Inherited Members

- Public Types inherited from Draw_Drawable3D
typedef Handle< Draw_Drawable3D >(*) FactoryFunction_t(Standard_IStream &theStream)
 Function type for restoring drawable from stream.
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Draw_Drawable3D
static void RegisterFactory (const Standard_CString theType, const FactoryFunction_t &theFactory)
 Register factory for restoring drawable from stream (opposite to Draw_Drawable3D::Save()).
 
static Handle< Draw_Drawable3DRestore (const Standard_CString theType, Standard_IStream &theStream)
 Restore drawable from stream (opposite to Draw_Drawable3D::Save()).
 
- 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.
 
- Protected Member Functions inherited from DrawTrSurf_Drawable
 DrawTrSurf_Drawable (const Standard_Integer discret, const Standard_Real deflection=0.01, const Standard_Integer DrawMode=0)
 set the number of points on a curve at creation.
 
- Protected Member Functions inherited from Draw_Drawable3D
 Draw_Drawable3D ()
 

Detailed Description

This class defines a drawable curve in 3d space.

Constructor & Destructor Documentation

◆ DrawTrSurf_Curve() [1/2]

DrawTrSurf_Curve::DrawTrSurf_Curve ( const Handle< Geom_Curve > & C,
const Standard_Boolean DispOrigin = Standard_True )

creates a drawable curve from a curve of package Geom.

◆ DrawTrSurf_Curve() [2/2]

DrawTrSurf_Curve::DrawTrSurf_Curve ( const Handle< Geom_Curve > & C,
const Draw_Color & aColor,
const Standard_Integer Discret,
const Standard_Real Deflection,
const Standard_Integer DrawMode,
const Standard_Boolean DispOrigin = Standard_True,
const Standard_Boolean DispCurvRadius = Standard_False,
const Standard_Real RadiusMax = 1.0e3,
const Standard_Real RatioOfRadius = 0.1 )

Member Function Documentation

◆ ClearCurvature()

void DrawTrSurf_Curve::ClearCurvature ( )
inline

◆ Color()

Draw_Color DrawTrSurf_Curve::Color ( ) const
inline

◆ Copy()

virtual Handle< Draw_Drawable3D > DrawTrSurf_Curve::Copy ( ) const
overridevirtual

For variable copy.

Reimplemented from Draw_Drawable3D.

Reimplemented in DrawTrSurf_BezierCurve, and DrawTrSurf_BSplineCurve.

◆ DisplayOrigin() [1/2]

Standard_Boolean DrawTrSurf_Curve::DisplayOrigin ( ) const
inline

◆ DisplayOrigin() [2/2]

void DrawTrSurf_Curve::DisplayOrigin ( const Standard_Boolean V)
inline

◆ DrawOn()

virtual void DrawTrSurf_Curve::DrawOn ( Draw_Display & dis) const
overridevirtual

this is defined only to tell C++ not to complain about inheriting a pure virtual method.

Implements DrawTrSurf_Drawable.

Reimplemented in DrawTrSurf_BezierCurve, and DrawTrSurf_BSplineCurve.

◆ Dump()

virtual void DrawTrSurf_Curve::Dump ( Standard_OStream & S) const
overridevirtual

For variable dump.

Reimplemented from Draw_Drawable3D.

◆ GetCurve()

Handle< Geom_Curve > DrawTrSurf_Curve::GetCurve ( ) const
inline

◆ RadiusMax()

Standard_Real DrawTrSurf_Curve::RadiusMax ( ) const
inline

◆ RadiusRatio()

Standard_Real DrawTrSurf_Curve::RadiusRatio ( ) const
inline

◆ Save()

virtual void DrawTrSurf_Curve::Save ( Standard_OStream & theStream) const
overridevirtual

Save drawable into stream.

Reimplemented from Draw_Drawable3D.

◆ SetColor()

void DrawTrSurf_Curve::SetColor ( const Draw_Color & theColor)
inline

◆ SetRadiusMax()

void DrawTrSurf_Curve::SetRadiusMax ( const Standard_Real theRadius)
inline

◆ SetRadiusRatio()

void DrawTrSurf_Curve::SetRadiusRatio ( const Standard_Real theRatio)
inline

◆ ShowCurvature()

void DrawTrSurf_Curve::ShowCurvature ( )
inline

◆ Whatis()

virtual void DrawTrSurf_Curve::Whatis ( Draw_Interpretor & I) const
overridevirtual

For variable whatis command. Set as a result the type of the variable.

Reimplemented from Draw_Drawable3D.

Field Documentation

◆ curv

Handle< Geom_Curve > DrawTrSurf_Curve::curv
protected

◆ dispcurvradius

Standard_Boolean DrawTrSurf_Curve::dispcurvradius
protected

◆ disporigin

Standard_Boolean DrawTrSurf_Curve::disporigin
protected

◆ look

Draw_Color DrawTrSurf_Curve::look
protected

◆ radiusmax

Standard_Real DrawTrSurf_Curve::radiusmax
protected

◆ radiusratio

Standard_Real DrawTrSurf_Curve::radiusratio
protected

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