Open CASCADE Technology 7.8.0
Public Member Functions
VrmlConverter_Drawer Class Reference

qualifies the aspect properties for the VRML conversation of a specific kind of object. This includes for example color, maximal chordial deviation, etc... More...

#include <VrmlConverter_Drawer.hxx>

Inheritance diagram for VrmlConverter_Drawer:
Inheritance graph
[legend]

Public Member Functions

 VrmlConverter_Drawer ()
 
void SetTypeOfDeflection (const Aspect_TypeOfDeflection aTypeOfDeflection)
 by default: TOD_Relative; however, except for the shapes, the drawing will be made using the absolute deviation.
 
Aspect_TypeOfDeflection TypeOfDeflection () const
 
void SetMaximalChordialDeviation (const Standard_Real aChordialDeviation)
 Defines the maximal chordial deviation when drawing any curve; If this value is one of the obvious parameters of methods, current value from Drawer won't be used. This value is used by:
 
Standard_Real MaximalChordialDeviation () const
 returns the maximal chordial deviation. Default value: 0.1
 
void SetDeviationCoefficient (const Standard_Real aCoefficient)
 default 0.001
 
Standard_Real DeviationCoefficient () const
 
void SetDiscretisation (const Standard_Integer d)
 default: 17 points. Defines the Discretisation (myNbPoints) when drawing any curve; If this value is one of the obvious parameters of methods, current value from Drawer won't be used. This value is used by:
 
Standard_Integer Discretisation () const
 
void SetMaximalParameterValue (const Standard_Real Value)
 defines the maximum value allowed for the first and last parameters of an infinite curve. Default value: 500. VrmlConverter_Curve VrmlConverter_WFRestrictedFace VrmlConverter_WFShape
 
Standard_Real MaximalParameterValue () const
 
void SetIsoOnPlane (const Standard_Boolean OnOff)
 enables the drawing of isos on planes. By default there are no isos on planes.
 
Standard_Boolean IsoOnPlane () const
 returns True if the drawing of isos on planes is enabled.
 
Handle< VrmlConverter_IsoAspectUIsoAspect ()
 Defines the attributes which are used when drawing an U isoparametric curve of a face. Defines the number of U isoparametric curves to be drawn for a single face. The default values are the same default values from Vrml package.
 
void SetUIsoAspect (const Handle< VrmlConverter_IsoAspect > &anAspect)
 
Handle< VrmlConverter_IsoAspectVIsoAspect ()
 Defines the attributes which are used when drawing an V isoparametric curve of a face. Defines the number of V isoparametric curves to be drawn for a single face. The default values are the same default values from Vrml package.
 
void SetVIsoAspect (const Handle< VrmlConverter_IsoAspect > &anAspect)
 
Handle< VrmlConverter_LineAspectFreeBoundaryAspect ()
 The default values are the same default values from Vrml package. These attributes are used by the following algorithms: VrmlConverter_WFShape VrmlConverter_WFDeflectionShape.
 
void SetFreeBoundaryAspect (const Handle< VrmlConverter_LineAspect > &anAspect)
 
void SetFreeBoundaryDraw (const Standard_Boolean OnOff)
 enables the drawing the free boundaries By default the free boundaries are drawn.
 
Standard_Boolean FreeBoundaryDraw () const
 returns True if the drawing of the free boundaries is enabled.
 
Handle< VrmlConverter_LineAspectWireAspect ()
 The default values are the same default values from Vrml package. These attributes are used by the following algorithms: VrmlConverter_WFShape VrmlConverter_WFDeflectionShape.
 
void SetWireAspect (const Handle< VrmlConverter_LineAspect > &anAspect)
 
void SetWireDraw (const Standard_Boolean OnOff)
 enables the drawing the wire By default the wire are drawn.
 
Standard_Boolean WireDraw () const
 returns True if the drawing of the wire is enabled.
 
Handle< VrmlConverter_LineAspectUnFreeBoundaryAspect ()
 The default values are the same default values from Vrml package. These attributes are used by the following algorithms: VrmlConverter_WFShape VrmlConverter_WFDeflectionShape.
 
void SetUnFreeBoundaryAspect (const Handle< VrmlConverter_LineAspect > &anAspect)
 
void SetUnFreeBoundaryDraw (const Standard_Boolean OnOff)
 enables the drawing the unfree boundaries By default the unfree boundaries are drawn.
 
Standard_Boolean UnFreeBoundaryDraw () const
 returns True if the drawing of the unfree boundaries is enabled.
 
Handle< VrmlConverter_LineAspectLineAspect ()
 The default values are the same default values from Vrml package.
 
void SetLineAspect (const Handle< VrmlConverter_LineAspect > &anAspect)
 
Handle< VrmlConverter_PointAspectPointAspect ()
 
void SetPointAspect (const Handle< VrmlConverter_PointAspect > &anAspect)
 
Handle< VrmlConverter_ShadingAspectShadingAspect ()
 The default values are the same default values from Vrml package.
 
void SetShadingAspect (const Handle< VrmlConverter_ShadingAspect > &anAspect)
 
Standard_Boolean DrawHiddenLine () const
 returns Standard_True if the hidden lines are to be drawn. By default the hidden lines are not drawn.
 
void EnableDrawHiddenLine ()
 sets DrawHiddenLine = Standard_True - the hidden lines are drawn.
 
void DisableDrawHiddenLine ()
 sets DrawHiddenLine = Standard_False - the hidden lines are not drawn.
 
Handle< VrmlConverter_LineAspectHiddenLineAspect ()
 returns LineAspect for the hidden lines. The default values are the same default values from Vrml package.
 
void SetHiddenLineAspect (const Handle< VrmlConverter_LineAspect > &anAspect)
 sets LineAspect for the hidden lines.
 
Handle< VrmlConverter_LineAspectSeenLineAspect ()
 returns LineAspect for the seen lines. The default values are the same default values from Vrml package.
 
void SetSeenLineAspect (const Handle< VrmlConverter_LineAspect > &anAspect)
 sets LineAspect for the seen lines.
 
- 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.
 

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 charget_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

qualifies the aspect properties for the VRML conversation of a specific kind of object. This includes for example color, maximal chordial deviation, etc...

Constructor & Destructor Documentation

◆ VrmlConverter_Drawer()

VrmlConverter_Drawer::VrmlConverter_Drawer ( )

Member Function Documentation

◆ DeviationCoefficient()

Standard_Real VrmlConverter_Drawer::DeviationCoefficient ( ) const

◆ DisableDrawHiddenLine()

void VrmlConverter_Drawer::DisableDrawHiddenLine ( )

sets DrawHiddenLine = Standard_False - the hidden lines are not drawn.

◆ Discretisation()

Standard_Integer VrmlConverter_Drawer::Discretisation ( ) const

◆ DrawHiddenLine()

Standard_Boolean VrmlConverter_Drawer::DrawHiddenLine ( ) const

returns Standard_True if the hidden lines are to be drawn. By default the hidden lines are not drawn.

◆ EnableDrawHiddenLine()

void VrmlConverter_Drawer::EnableDrawHiddenLine ( )

sets DrawHiddenLine = Standard_True - the hidden lines are drawn.

◆ FreeBoundaryAspect()

Handle< VrmlConverter_LineAspect > VrmlConverter_Drawer::FreeBoundaryAspect ( )

The default values are the same default values from Vrml package. These attributes are used by the following algorithms: VrmlConverter_WFShape VrmlConverter_WFDeflectionShape.

◆ FreeBoundaryDraw()

Standard_Boolean VrmlConverter_Drawer::FreeBoundaryDraw ( ) const

returns True if the drawing of the free boundaries is enabled.

◆ HiddenLineAspect()

Handle< VrmlConverter_LineAspect > VrmlConverter_Drawer::HiddenLineAspect ( )

returns LineAspect for the hidden lines. The default values are the same default values from Vrml package.

◆ IsoOnPlane()

Standard_Boolean VrmlConverter_Drawer::IsoOnPlane ( ) const

returns True if the drawing of isos on planes is enabled.

◆ LineAspect()

Handle< VrmlConverter_LineAspect > VrmlConverter_Drawer::LineAspect ( )

The default values are the same default values from Vrml package.

◆ MaximalChordialDeviation()

Standard_Real VrmlConverter_Drawer::MaximalChordialDeviation ( ) const

returns the maximal chordial deviation. Default value: 0.1

◆ MaximalParameterValue()

Standard_Real VrmlConverter_Drawer::MaximalParameterValue ( ) const

◆ PointAspect()

Handle< VrmlConverter_PointAspect > VrmlConverter_Drawer::PointAspect ( )

◆ SeenLineAspect()

Handle< VrmlConverter_LineAspect > VrmlConverter_Drawer::SeenLineAspect ( )

returns LineAspect for the seen lines. The default values are the same default values from Vrml package.

◆ SetDeviationCoefficient()

void VrmlConverter_Drawer::SetDeviationCoefficient ( const Standard_Real  aCoefficient)

default 0.001

◆ SetDiscretisation()

void VrmlConverter_Drawer::SetDiscretisation ( const Standard_Integer  d)

default: 17 points. Defines the Discretisation (myNbPoints) when drawing any curve; If this value is one of the obvious parameters of methods, current value from Drawer won't be used. This value is used by:

VrmlConverter_Curve VrmlConverter_WFRestrictedFace VrmlConverter_WFShape

◆ SetFreeBoundaryAspect()

void VrmlConverter_Drawer::SetFreeBoundaryAspect ( const Handle< VrmlConverter_LineAspect > &  anAspect)

◆ SetFreeBoundaryDraw()

void VrmlConverter_Drawer::SetFreeBoundaryDraw ( const Standard_Boolean  OnOff)

enables the drawing the free boundaries By default the free boundaries are drawn.

◆ SetHiddenLineAspect()

void VrmlConverter_Drawer::SetHiddenLineAspect ( const Handle< VrmlConverter_LineAspect > &  anAspect)

sets LineAspect for the hidden lines.

◆ SetIsoOnPlane()

void VrmlConverter_Drawer::SetIsoOnPlane ( const Standard_Boolean  OnOff)

enables the drawing of isos on planes. By default there are no isos on planes.

◆ SetLineAspect()

void VrmlConverter_Drawer::SetLineAspect ( const Handle< VrmlConverter_LineAspect > &  anAspect)

◆ SetMaximalChordialDeviation()

void VrmlConverter_Drawer::SetMaximalChordialDeviation ( const Standard_Real  aChordialDeviation)

Defines the maximal chordial deviation when drawing any curve; If this value is one of the obvious parameters of methods, current value from Drawer won't be used. This value is used by:

VrmlConverter_DeflectionCurve VrmlConverter_WFDeflectionRestrictedFace VrmlConverter_WFDeflectionShape

◆ SetMaximalParameterValue()

void VrmlConverter_Drawer::SetMaximalParameterValue ( const Standard_Real  Value)

defines the maximum value allowed for the first and last parameters of an infinite curve. Default value: 500. VrmlConverter_Curve VrmlConverter_WFRestrictedFace VrmlConverter_WFShape

◆ SetPointAspect()

void VrmlConverter_Drawer::SetPointAspect ( const Handle< VrmlConverter_PointAspect > &  anAspect)

◆ SetSeenLineAspect()

void VrmlConverter_Drawer::SetSeenLineAspect ( const Handle< VrmlConverter_LineAspect > &  anAspect)

sets LineAspect for the seen lines.

◆ SetShadingAspect()

void VrmlConverter_Drawer::SetShadingAspect ( const Handle< VrmlConverter_ShadingAspect > &  anAspect)

◆ SetTypeOfDeflection()

void VrmlConverter_Drawer::SetTypeOfDeflection ( const Aspect_TypeOfDeflection  aTypeOfDeflection)

by default: TOD_Relative; however, except for the shapes, the drawing will be made using the absolute deviation.

◆ SetUIsoAspect()

void VrmlConverter_Drawer::SetUIsoAspect ( const Handle< VrmlConverter_IsoAspect > &  anAspect)

◆ SetUnFreeBoundaryAspect()

void VrmlConverter_Drawer::SetUnFreeBoundaryAspect ( const Handle< VrmlConverter_LineAspect > &  anAspect)

◆ SetUnFreeBoundaryDraw()

void VrmlConverter_Drawer::SetUnFreeBoundaryDraw ( const Standard_Boolean  OnOff)

enables the drawing the unfree boundaries By default the unfree boundaries are drawn.

◆ SetVIsoAspect()

void VrmlConverter_Drawer::SetVIsoAspect ( const Handle< VrmlConverter_IsoAspect > &  anAspect)

◆ SetWireAspect()

void VrmlConverter_Drawer::SetWireAspect ( const Handle< VrmlConverter_LineAspect > &  anAspect)

◆ SetWireDraw()

void VrmlConverter_Drawer::SetWireDraw ( const Standard_Boolean  OnOff)

enables the drawing the wire By default the wire are drawn.

◆ ShadingAspect()

Handle< VrmlConverter_ShadingAspect > VrmlConverter_Drawer::ShadingAspect ( )

The default values are the same default values from Vrml package.

◆ TypeOfDeflection()

Aspect_TypeOfDeflection VrmlConverter_Drawer::TypeOfDeflection ( ) const

◆ UIsoAspect()

Handle< VrmlConverter_IsoAspect > VrmlConverter_Drawer::UIsoAspect ( )

Defines the attributes which are used when drawing an U isoparametric curve of a face. Defines the number of U isoparametric curves to be drawn for a single face. The default values are the same default values from Vrml package.

These attributes are used by the following algorithms: VrmlConverter_WFRestrictedFace VrmlConverter_WFDeflectionRestrictedFace

◆ UnFreeBoundaryAspect()

Handle< VrmlConverter_LineAspect > VrmlConverter_Drawer::UnFreeBoundaryAspect ( )

The default values are the same default values from Vrml package. These attributes are used by the following algorithms: VrmlConverter_WFShape VrmlConverter_WFDeflectionShape.

◆ UnFreeBoundaryDraw()

Standard_Boolean VrmlConverter_Drawer::UnFreeBoundaryDraw ( ) const

returns True if the drawing of the unfree boundaries is enabled.

◆ VIsoAspect()

Handle< VrmlConverter_IsoAspect > VrmlConverter_Drawer::VIsoAspect ( )

Defines the attributes which are used when drawing an V isoparametric curve of a face. Defines the number of V isoparametric curves to be drawn for a single face. The default values are the same default values from Vrml package.

These attributes are used by the following algorithms: VrmlConverter_WFRestrictedFace VrmlConverter_WFDeflectionRestrictedFace

◆ WireAspect()

Handle< VrmlConverter_LineAspect > VrmlConverter_Drawer::WireAspect ( )

The default values are the same default values from Vrml package. These attributes are used by the following algorithms: VrmlConverter_WFShape VrmlConverter_WFDeflectionShape.

◆ WireDraw()

Standard_Boolean VrmlConverter_Drawer::WireDraw ( ) const

returns True if the drawing of the wire is enabled.


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