# Visualization
TKV3d
Select3D

# Select3D_SensitiveSegment Class Reference

A framework to define sensitive zones along a segment
One gives the 3D start and end point;
the maximum number of 2D boxes given
by this entity may be set by the user
if the projected segment is
vertical or horizontal, one needs only 1 box.
for a pi/4 angle -> MaxNumber 2D boxes
.

`#include <Select3D_SensitiveSegment.hxx>`

Inheritance diagram for Select3D_SensitiveSegment:

[legend]

## Public Member Functions

Standard_EXPORT | Select3D_SensitiveSegment (const Handle(SelectBasics_EntityOwner)&OwnerId, const gp_Pnt &FirstP, const gp_Pnt &LastP, const Standard_Integer MaxRect=1)
| Constructs the sensitive segment object defined by the owner OwnerId, the points FirstP, LastP and the maximum number of sensitive bounding boxes MaxRect. .
void | Set (const Standard_Integer MaxRect)
| Sets the maximum number of sensitive rectangles MaxRect. .
void | StartPoint (const gp_Pnt &aPt)
| changes the start Point of the Segment;
void | EndPoint (const gp_Pnt &aPt)
| changes the end point of the segment
gp_Pnt | StartPoint () const
| gives the 3D start Point of the Segment
gp_Pnt | EndPoint () const
| gives the 3D End Point of the Segment
virtual Standard_EXPORT void | Project (const Select3D_Projector &aProjector)
| projection of the sensitive primitive in order to get 2D boxes for the Sort Algorithm
Standard_EXPORT void | Areas (SelectBasics_ListOfBox2d &boxes)
| gives the 2D boxes which represent the segment in the selection process...
Standard_EXPORT Handle_Select3D_SensitiveEntity | GetConnected (const TopLoc_Location &aLocation)
| Returns the sensitive entity found at the location aLocation. You must redefine this function for any type of sensitive entity which can accept another connected sensitive entity.//can be connected to another sensitive entity. .
Standard_EXPORT Standard_Boolean | Matches (const Standard_Real X, const Standard_Real Y, const Standard_Real aTol, Standard_Real &DMin)
| projection of the sensitive primitive in order to get 2D boxes for the Sort Algorithm
Standard_EXPORT Standard_Boolean | Matches (const Standard_Real XMin, const Standard_Real YMin, const Standard_Real XMax, const Standard_Real YMax, const Standard_Real aTol)

Matches the box defined by the coordinates Xmin,
Ymin, Xmax, Ymax with the entity found at that point
within the tolerance aTol.
Xmin, YMin define the minimum point in the lower left
hand corner of the box, and XMax, YMax define the
maximum point in the upper right hand corner of the box.
You must redefine this function for every inheriting entity.
You will have to call this framework inside the redefined function.
.

virtual Standard_EXPORT Standard_Boolean | Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol)
| prevents from hiding virtual methods...
Standard_EXPORT Standard_Real | ComputeDepth (const gp_Lin &EyeLine) const
| Returns the depth of this object on the line EyeLine. EyeLine goes through the eye towards a point defined by the coordinates X,Y in the function GetEyeLine. //! gives an abcissa on <alin> . <alin> represents the line going through the eye towards an X,Y point on the screen. This Method must return a mean Depth on this line. .
Standard_Integer | MaxBoxes () const
| returns <mymaxrect>
virtual Standard_EXPORT void | Dump (Standard_OStream &S, const Standard_Boolean FullDump=Standard_True) const
| 2 options : <fulldump> = False -> general information <fulldump> = True -> whole informtion 3D +2d ...
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Attributes

Standard_Integer | mymaxrect
Select3D_Pnt | mystart
Select3D_Pnt | myend
Select3D_Pnt2d | myprojstart
Select3D_Pnt2d | myprojend

## Constructor & Destructor Documentation

Standard_EXPORT Select3D_SensitiveSegment::Select3D_SensitiveSegment | ( | const Handle(SelectBasics_EntityOwner)& | OwnerId,
|  | const gp_Pnt & | FirstP,
|  | const gp_Pnt & | LastP,
|  | const Standard_Integer | MaxRect = `1`
| ) |

## Member Function Documentation

Standard_EXPORT void Select3D_SensitiveSegment::Areas | ( | SelectBasics_ListOfBox2d & | boxes | ) | `[virtual]`

| Implements SelectBasics_SensitiveEntity.

Standard_EXPORT Standard_Real Select3D_SensitiveSegment::ComputeDepth | ( | const gp_Lin & | EyeLine | ) | const`[virtual]`

| Implements Select3D_SensitiveEntity.

virtual Standard_EXPORT void Select3D_SensitiveSegment::Dump | ( | Standard_OStream & | S,
|  | const Standard_Boolean | FullDump = `Standard_True`
| ) | const`[virtual]`

| Reimplemented from Select3D_SensitiveEntity.

gp_Pnt Select3D_SensitiveSegment::EndPoint | ( |  | ) | const`[inline]`

void Select3D_SensitiveSegment::EndPoint | ( | const gp_Pnt & | aPt | ) | `[inline]`

Standard_EXPORT Handle_Select3D_SensitiveEntity Select3D_SensitiveSegment::GetConnected | ( | const TopLoc_Location & | aLocation | ) | `[virtual]`

| Reimplemented from Select3D_SensitiveEntity.

Standard_EXPORT const Select3D_SensitiveSegment::Handle | ( | Standard_Type |  | ) | const

| Reimplemented from Select3D_SensitiveEntity. Reimplemented in MeshVS_SensitiveSegment.

virtual Standard_EXPORT Standard_Boolean Select3D_SensitiveSegment::Matches | ( | const TColgp_Array1OfPnt2d & | Polyline,
|  | const Bnd_Box2d & | aBox,
|  | const Standard_Real | aTol
| ) | `[virtual]`

| Reimplemented from Select3D_SensitiveEntity. Reimplemented in MeshVS_SensitiveSegment.

Standard_EXPORT Standard_Boolean Select3D_SensitiveSegment::Matches | ( | const Standard_Real | XMin,
|  | const Standard_Real | YMin,
|  | const Standard_Real | XMax,
|  | const Standard_Real | YMax,
|  | const Standard_Real | aTol
| ) | `[virtual]`

| Reimplemented from Select3D_SensitiveEntity. Reimplemented in MeshVS_SensitiveSegment.

Standard_EXPORT Standard_Boolean Select3D_SensitiveSegment::Matches | ( | const Standard_Real | X,
|  | const Standard_Real | Y,
|  | const Standard_Real | aTol,
|  | Standard_Real & | DMin
| ) | `[virtual]`

| Reimplemented from Select3D_SensitiveEntity.

Standard_Integer Select3D_SensitiveSegment::MaxBoxes | ( |  | ) | const`[inline, virtual]`

| Reimplemented from Select3D_SensitiveEntity.

virtual Standard_EXPORT void Select3D_SensitiveSegment::Project | ( | const Select3D_Projector & | aProjector | ) | `[virtual]`

| Reimplemented from Select3D_SensitiveEntity. Reimplemented in MeshVS_SensitiveSegment.

void Select3D_SensitiveSegment::Set | ( | const Standard_Integer | MaxRect | ) | `[inline]`

gp_Pnt Select3D_SensitiveSegment::StartPoint | ( |  | ) | const`[inline]`

void Select3D_SensitiveSegment::StartPoint | ( | const gp_Pnt & | aPt | ) | `[inline]`

## Field Documentation

Select3D_Pnt Select3D_SensitiveSegment::myend `[private]`

Standard_Integer Select3D_SensitiveSegment::mymaxrect `[private]`

Select3D_Pnt2d Select3D_SensitiveSegment::myprojend `[private]`

Select3D_Pnt2d Select3D_SensitiveSegment::myprojstart `[private]`

Select3D_Pnt Select3D_SensitiveSegment::mystart `[private]`

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

- Select3D_SensitiveSegment.hxx
- Select3D_SensitiveSegment.lxx