Open CASCADE Technology  7.1.0.beta
Public Member Functions

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...
 
Handle< Prs3d_LineAspectEdgesAspect () const
 Returns the attributes of displayed edges involved in the presentation of planes. More...
 
Handle< Prs3d_LineAspectIsoAspect () const
 Returns the attributes of displayed isoparameters involved in the presentation of planes. More...
 
Handle< Prs3d_LineAspectArrowAspect () const
 Returns the settings for displaying an arrow. More...
 
void SetArrowsLength (const Quantity_Length L)
 
Quantity_Length ArrowsLength () const
 Returns the length of the arrow shaft used in the display of arrows. More...
 
void SetArrowsSize (const Quantity_Length L)
 Sets the angle of the arrowhead used in the display of planes. More...
 
Quantity_Length ArrowsSize () const
 Returns the size of arrows used in the display of planes. More...
 
void SetArrowsAngle (const Quantity_PlaneAngle ang)
 Sets the angle of the arrowhead used in the display of arrows involved in the presentation of planes. More...
 
Quantity_PlaneAngle 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 draw)
 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 draw)
 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 draw)
 
Standard_Boolean DisplayEdges () const
 
void SetDisplayIso (const Standard_Boolean draw)
 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 Quantity_Length LX, const Quantity_Length LY)
 
Quantity_Length PlaneXLength () const
 Returns the length of the x axis used in the display of planes. More...
 
Quantity_Length PlaneYLength () const
 Returns the length of the y axis used in the display of planes. More...
 
void SetIsoDistance (const Quantity_Length L)
 Sets the distance L between isoparameters used in the display of planes. More...
 
Quantity_Length IsoDistance () const
 Returns the distance between isoparameters used in the display of planes. More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const override
 Memory deallocator for transient classes. 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 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...
 

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 ( )

Constructs an empty framework for the display of planes.

Member Function Documentation

Handle< Prs3d_LineAspect > Prs3d_PlaneAspect::ArrowAspect ( ) const

Returns the settings for displaying an arrow.

Quantity_PlaneAngle Prs3d_PlaneAspect::ArrowsAngle ( ) const

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

Quantity_Length Prs3d_PlaneAspect::ArrowsLength ( ) const

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

Quantity_Length Prs3d_PlaneAspect::ArrowsSize ( ) const

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

Standard_Boolean Prs3d_PlaneAspect::DisplayCenterArrow ( ) const

Returns true if the display of center arrows is allowed.

Standard_Boolean Prs3d_PlaneAspect::DisplayEdges ( ) const
Standard_Boolean Prs3d_PlaneAspect::DisplayEdgesArrows ( ) const

Returns true if the display of edge arrows is allowed.

Standard_Boolean Prs3d_PlaneAspect::DisplayIso ( ) const

Returns true if the display of isoparameters is allowed.

Handle< Prs3d_LineAspect > Prs3d_PlaneAspect::EdgesAspect ( ) const

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

Handle< Prs3d_LineAspect > Prs3d_PlaneAspect::IsoAspect ( ) const

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

Quantity_Length Prs3d_PlaneAspect::IsoDistance ( ) const

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

Quantity_Length Prs3d_PlaneAspect::PlaneXLength ( ) const

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

Quantity_Length Prs3d_PlaneAspect::PlaneYLength ( ) const

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

void Prs3d_PlaneAspect::SetArrowsAngle ( const Quantity_PlaneAngle  ang)

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

void Prs3d_PlaneAspect::SetArrowsLength ( const Quantity_Length  L)
void Prs3d_PlaneAspect::SetArrowsSize ( const Quantity_Length  L)

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

void Prs3d_PlaneAspect::SetDisplayCenterArrow ( const Standard_Boolean  draw)

Sets the display attributes defined in DisplayCenterArrow to active.

void Prs3d_PlaneAspect::SetDisplayEdges ( const Standard_Boolean  draw)
void Prs3d_PlaneAspect::SetDisplayEdgesArrows ( const Standard_Boolean  draw)

Sets the display attributes defined in DisplayEdgesArrows to active.

void Prs3d_PlaneAspect::SetDisplayIso ( const Standard_Boolean  draw)

Sets the display attributes defined in DisplayIso to active.

void Prs3d_PlaneAspect::SetIsoDistance ( const Quantity_Length  L)

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

void Prs3d_PlaneAspect::SetPlaneLength ( const Quantity_Length  LX,
const Quantity_Length  LY 
)

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