Prs3d_Arrow Class Reference

Provides class methods to draw an arrow at a given location, along a given direction and using a given angle. More...

#include <Prs3d_Arrow.hxx>

Inheritance diagram for Prs3d_Arrow:

Public Member Functions
	Standard_DEPRECATED ("Prs3d_Arrow::Draw() taking Graphic3d_Group should be used instead") static void Draw(const Handle< Prs3d_Presentation > &thePrs
	Alias to another method Draw() for backward compatibility. More...

Static Public Member Functions
static Handle< Graphic3d_ArrayOfTriangles >	DrawShaded (const gp_Ax1 &theAxis, const Standard_Real theTubeRadius, const Standard_Real theAxisLength, const Standard_Real theConeRadius, const Standard_Real theConeLength, const Standard_Integer theNbFacettes)
	Defines the representation of the arrow as shaded triangulation. More...
static Handle< Graphic3d_ArrayOfSegments >	DrawSegments (const gp_Pnt &theLocation, const gp_Dir &theDir, const Standard_Real theAngle, const Standard_Real theLength, const Standard_Integer theNbSegments)
	Defines the representation of the arrow as a container of segments. More...
static void	Draw (const Handle< Graphic3d_Group > &theGroup, const gp_Pnt &theLocation, const gp_Dir &theDirection, const Standard_Real theAngle, const Standard_Real theLength)
	Defines the representation of the arrow. Note that this method does NOT assign any presentation aspects to the primitives group! More...
Static Public Member Functions inherited from Prs3d_Root
static Handle< Graphic3d_Group >	CurrentGroup (const Handle< Prs3d_Presentation > &thePrs3d)
	Returns the current (last created) group of primititves inside graphic objects in the display. A group also contains the attributes whose ranges are limited to the primitives in it. More...
static Handle< Graphic3d_Group >	NewGroup (const Handle< Prs3d_Presentation > &thePrs3d)
	Returns the new group of primitives inside graphic objects in the display. A group also contains the attributes whose ranges are limited to the primitives in it. More...

Data Fields
const gp_Pnt &	theLocation
const gp_Pnt const gp_Dir &	theDirection
const gp_Pnt const gp_Dir const Standard_Real	theAngle
const gp_Pnt const gp_Dir const Standard_Real const Standard_Real	theLength

Detailed Description

Provides class methods to draw an arrow at a given location, along a given direction and using a given angle.

Member Function Documentation

Draw()

static void Prs3d_Arrow::Draw ( const Handle< Graphic3d_Group > &  theGroup, const gp_Pnt &  theLocation, const gp_Dir &  theDirection, const Standard_Real  theAngle, const Standard_Real  theLength  )

static

Defines the representation of the arrow. Note that this method does NOT assign any presentation aspects to the primitives group!

Parameters

theGroup	presentation group to add primitives
theLocation	location of the arrow tip
theDirection	direction of the arrow
theAngle	angle of opening of the arrow head
theLength	length of the arrow (from the tip)

DrawSegments()

static Handle< Graphic3d_ArrayOfSegments > Prs3d_Arrow::DrawSegments ( const gp_Pnt &  theLocation, const gp_Dir &  theDir, const Standard_Real  theAngle, const Standard_Real  theLength, const Standard_Integer  theNbSegments  )

static

Defines the representation of the arrow as a container of segments.

Parameters

theLocation	location of the arrow tip
theDir	direction of the arrow
theAngle	angle of opening of the arrow head
theLength	length of the arrow (from the tip)
theNbSegments	count of points on polyline where location is connected

DrawShaded()

static Handle< Graphic3d_ArrayOfTriangles > Prs3d_Arrow::DrawShaded ( const gp_Ax1 &  theAxis, const Standard_Real  theTubeRadius, const Standard_Real  theAxisLength, const Standard_Real  theConeRadius, const Standard_Real  theConeLength, const Standard_Integer  theNbFacettes  )

static

Defines the representation of the arrow as shaded triangulation.

Parameters

theAxis	axis definition (arrow origin and direction)
theTubeRadius	tube (cylinder) radius
theAxisLength	overall arrow length (cylinder + cone)
theConeRadius	cone radius (arrow tip)
theConeLength	cone length (arrow tip)
theNbFacettes	tessellation quality for each part

Standard_DEPRECATED()

Prs3d_Arrow::Standard_DEPRECATED

(

"Prs3d_Arrow::Draw() taking Graphic3d_Group should be used instead"

)

const &

Alias to another method Draw() for backward compatibility.

Field Documentation

theAngle

const gp_Pnt const gp_Dir const Standard_Real Prs3d_Arrow::theAngle

theDirection

const gp_Pnt const gp_Dir& Prs3d_Arrow::theDirection

theLength

const gp_Pnt const gp_Dir const Standard_Real const Standard_Real Prs3d_Arrow::theLength

Initial value:

{
    Draw (Prs3d_Root::CurrentGroup (thePrs), theLocation, theDirection, theAngle, theLength)

theLocation

const gp_Pnt& Prs3d_Arrow::theLocation

---

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

• Prs3d_Arrow.hxx