Open CASCADE Technology  7.4.0
Public Member Functions | Protected Attributes
Prs3d_PlaneAspect Class Reference

A framework to define the display of planes. More...

#include <Prs3d_PlaneAspect.hxx>

Inheritance diagram for Prs3d_PlaneAspect:
Inheritance graph
[legend]

Public Member Functions

 Prs3d_PlaneAspect ()
 Constructs an empty framework for the display of planes. More...
 
const Handle< Prs3d_LineAspect > & EdgesAspect () const
 Returns the attributes of displayed edges involved in the presentation of planes. More...
 
const Handle< Prs3d_LineAspect > & IsoAspect () const
 Returns the attributes of displayed isoparameters involved in the presentation of planes. More...
 
const Handle< Prs3d_LineAspect > & ArrowAspect () const
 Returns the settings for displaying an arrow. More...
 
void SetArrowsLength (const Standard_Real theLength)
 
Standard_Real ArrowsLength () const
 Returns the length of the arrow shaft used in the display of arrows. More...
 
void SetArrowsSize (const Standard_Real theSize)
 Sets the angle of the arrowhead used in the display of planes. More...
 
Standard_Real ArrowsSize () const
 Returns the size of arrows used in the display of planes. More...
 
void SetArrowsAngle (const Standard_Real theAngle)
 Sets the angle of the arrowhead used in the display of arrows involved in the presentation of planes. More...
 
Standard_Real ArrowsAngle () const
 Returns the angle of the arrowhead used in the display of arrows involved in the presentation of planes. More...
 
void SetDisplayCenterArrow (const Standard_Boolean theToDraw)
 Sets the display attributes defined in DisplayCenterArrow to active. More...
 
Standard_Boolean DisplayCenterArrow () const
 Returns true if the display of center arrows is allowed. More...
 
void SetDisplayEdgesArrows (const Standard_Boolean theToDraw)
 Sets the display attributes defined in DisplayEdgesArrows to active. More...
 
Standard_Boolean DisplayEdgesArrows () const
 Returns true if the display of edge arrows is allowed. More...
 
void SetDisplayEdges (const Standard_Boolean theToDraw)
 
Standard_Boolean DisplayEdges () const
 
void SetDisplayIso (const Standard_Boolean theToDraw)
 Sets the display attributes defined in DisplayIso to active. More...
 
Standard_Boolean DisplayIso () const
 Returns true if the display of isoparameters is allowed. More...
 
void SetPlaneLength (const Standard_Real theLX, const Standard_Real theLY)
 
Standard_Real PlaneXLength () const
 Returns the length of the x axis used in the display of planes. More...
 
Standard_Real PlaneYLength () const
 Returns the length of the y axis used in the display of planes. More...
 
void SetIsoDistance (const Standard_Real theL)
 Sets the distance L between isoparameters used in the display of planes. More...
 
Standard_Real IsoDistance () const
 Returns the distance between isoparameters used in the display of planes. More...
 
virtual void DumpJson (Standard_OStream &theOStream, const 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< Prs3d_LineAspectmyEdgesAspect
 
Handle< Prs3d_LineAspectmyIsoAspect
 
Handle< Prs3d_LineAspectmyArrowAspect
 
Standard_Real myArrowsLength
 
Standard_Real myArrowsSize
 
Standard_Real myArrowsAngle
 
Standard_Real myPlaneXLength
 
Standard_Real myPlaneYLength
 
Standard_Real myIsoDistance
 
Standard_Boolean myDrawCenterArrow
 
Standard_Boolean myDrawEdgesArrows
 
Standard_Boolean myDrawEdges
 
Standard_Boolean myDrawIso
 

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

A framework to define the display of planes.

Constructor & Destructor Documentation

◆ Prs3d_PlaneAspect()

Prs3d_PlaneAspect::Prs3d_PlaneAspect ( )

Constructs an empty framework for the display of planes.

Member Function Documentation

◆ ArrowAspect()

const Handle< Prs3d_LineAspect >& Prs3d_PlaneAspect::ArrowAspect ( ) const
inline

Returns the settings for displaying an arrow.

◆ ArrowsAngle()

Standard_Real Prs3d_PlaneAspect::ArrowsAngle ( ) const
inline

Returns the angle of the arrowhead used in the display of arrows involved in the presentation of planes.

◆ ArrowsLength()

Standard_Real Prs3d_PlaneAspect::ArrowsLength ( ) const
inline

Returns the length of the arrow shaft used in the display of arrows.

◆ ArrowsSize()

Standard_Real Prs3d_PlaneAspect::ArrowsSize ( ) const
inline

Returns the size of arrows used in the display of planes.

◆ DisplayCenterArrow()

Standard_Boolean Prs3d_PlaneAspect::DisplayCenterArrow ( ) const
inline

Returns true if the display of center arrows is allowed.

◆ DisplayEdges()

Standard_Boolean Prs3d_PlaneAspect::DisplayEdges ( ) const
inline

◆ DisplayEdgesArrows()

Standard_Boolean Prs3d_PlaneAspect::DisplayEdgesArrows ( ) const
inline

Returns true if the display of edge arrows is allowed.

◆ DisplayIso()

Standard_Boolean Prs3d_PlaneAspect::DisplayIso ( ) const
inline

Returns true if the display of isoparameters is allowed.

◆ DumpJson()

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

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

◆ EdgesAspect()

const Handle< Prs3d_LineAspect >& Prs3d_PlaneAspect::EdgesAspect ( ) const
inline

Returns the attributes of displayed edges involved in the presentation of planes.

◆ IsoAspect()

const Handle< Prs3d_LineAspect >& Prs3d_PlaneAspect::IsoAspect ( ) const
inline

Returns the attributes of displayed isoparameters involved in the presentation of planes.

◆ IsoDistance()

Standard_Real Prs3d_PlaneAspect::IsoDistance ( ) const
inline

Returns the distance between isoparameters used in the display of planes.

◆ PlaneXLength()

Standard_Real Prs3d_PlaneAspect::PlaneXLength ( ) const
inline

Returns the length of the x axis used in the display of planes.

◆ PlaneYLength()

Standard_Real Prs3d_PlaneAspect::PlaneYLength ( ) const
inline

Returns the length of the y axis used in the display of planes.

◆ SetArrowsAngle()

void Prs3d_PlaneAspect::SetArrowsAngle ( const Standard_Real  theAngle)
inline

Sets the angle of the arrowhead used in the display of arrows involved in the presentation of planes.

◆ SetArrowsLength()

void Prs3d_PlaneAspect::SetArrowsLength ( const Standard_Real  theLength)
inline

◆ SetArrowsSize()

void Prs3d_PlaneAspect::SetArrowsSize ( const Standard_Real  theSize)
inline

Sets the angle of the arrowhead used in the display of planes.

◆ SetDisplayCenterArrow()

void Prs3d_PlaneAspect::SetDisplayCenterArrow ( const Standard_Boolean  theToDraw)
inline

Sets the display attributes defined in DisplayCenterArrow to active.

◆ SetDisplayEdges()

void Prs3d_PlaneAspect::SetDisplayEdges ( const Standard_Boolean  theToDraw)
inline

◆ SetDisplayEdgesArrows()

void Prs3d_PlaneAspect::SetDisplayEdgesArrows ( const Standard_Boolean  theToDraw)
inline

Sets the display attributes defined in DisplayEdgesArrows to active.

◆ SetDisplayIso()

void Prs3d_PlaneAspect::SetDisplayIso ( const Standard_Boolean  theToDraw)
inline

Sets the display attributes defined in DisplayIso to active.

◆ SetIsoDistance()

void Prs3d_PlaneAspect::SetIsoDistance ( const Standard_Real  theL)
inline

Sets the distance L between isoparameters used in the display of planes.

◆ SetPlaneLength()

void Prs3d_PlaneAspect::SetPlaneLength ( const Standard_Real  theLX,
const Standard_Real  theLY 
)
inline

Field Documentation

◆ myArrowAspect

Handle< Prs3d_LineAspect > Prs3d_PlaneAspect::myArrowAspect
protected

◆ myArrowsAngle

Standard_Real Prs3d_PlaneAspect::myArrowsAngle
protected

◆ myArrowsLength

Standard_Real Prs3d_PlaneAspect::myArrowsLength
protected

◆ myArrowsSize

Standard_Real Prs3d_PlaneAspect::myArrowsSize
protected

◆ myDrawCenterArrow

Standard_Boolean Prs3d_PlaneAspect::myDrawCenterArrow
protected

◆ myDrawEdges

Standard_Boolean Prs3d_PlaneAspect::myDrawEdges
protected

◆ myDrawEdgesArrows

Standard_Boolean Prs3d_PlaneAspect::myDrawEdgesArrows
protected

◆ myDrawIso

Standard_Boolean Prs3d_PlaneAspect::myDrawIso
protected

◆ myEdgesAspect

Handle< Prs3d_LineAspect > Prs3d_PlaneAspect::myEdgesAspect
protected

◆ myIsoAspect

Handle< Prs3d_LineAspect > Prs3d_PlaneAspect::myIsoAspect
protected

◆ myIsoDistance

Standard_Real Prs3d_PlaneAspect::myIsoDistance
protected

◆ myPlaneXLength

Standard_Real Prs3d_PlaneAspect::myPlaneXLength
protected

◆ myPlaneYLength

Standard_Real Prs3d_PlaneAspect::myPlaneYLength
protected

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