# Visualization
TKV3d
AIS

# AIS_Line Class Reference

Constructs line datums to be used in construction of
composite shapes.
.

`#include <AIS_Line.hxx>`

Inheritance diagram for AIS_Line:

[legend]

## Public Member Functions

Standard_EXPORT | AIS_Line (const Handle(Geom_Line)&aLine)
| Initializes the line aLine. .
Standard_EXPORT | AIS_Line (const Handle(Geom_Point)&aStartPoint, const Handle(Geom_Point)&aEndPoint)
| Initializes a starting point aStartPoint and a finishing point aEndPoint for the line. .
virtual Standard_EXPORT void | Compute (const Handle(Prs3d_Projector)&aProjector, const Handle(Geom_Transformation)&aTrsf, const Handle(Prs3d_Presentation)&aPresentation)
| computes the presentation according to a point of view given by <aprojector>. To be Used when the associated degenerated Presentations have been transformed by <atrsf> which is not a Pure Translation. The HLR Prs can't be deducted automatically WARNING :<atrsf> must be applied to the object to display before computation !!!
virtual Standard_Integer | Signature () const
| Returns the signature 5. .
virtual AIS_KindOfInteractive | Type () const
| Returns the type Datum. .
const Handle_Geom_Line & | Line () const
| Constructs an infinite line. .
void | Points (Handle(Geom_Point)&PStart, Handle(Geom_Point)&PEnd) const
| Returns the starting point PStart and the end point PEnd of the line set by SetPoints. .
void | SetLine (const Handle(Geom_Line)&L)
| instantiates an infinite line.
void | SetPoints (const Handle(Geom_Point)&P1, const Handle(Geom_Point)&P2)
| Sets the starting point P1 and ending point P2 of the infinite line to create a finite line segment. .
Standard_EXPORT void | SetColor (const Quantity_NameOfColor aColor)
| Provides a new color setting aColor for the line in the drawing tool, or "Drawer". .
Standard_EXPORT void | SetColor (const Quantity_Color &aColor)
Standard_EXPORT void | SetWidth (const Standard_Real aValue)
| Provides the new width setting aValue for the line in the drawing tool, or "Drawer". .
Standard_EXPORT void | UnsetColor ()
| Removes the color setting and returns the original color. .
Standard_EXPORT void | UnsetWidth ()
| Removes the width setting and returns the original width. .
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Member Functions

Standard_EXPORT void | Compute (const Handle(PrsMgr_PresentationManager3d)&aPresentationManager, const Handle(Prs3d_Presentation)&aPresentation, const Standard_Integer aMode=0)
| Calculates the 3D view aPresentation and its updates. The latter are managed by aPresentationManager. aPresentableObject has the display mode aMode; this has the default value of 0, that is, the wireframe display mode. .
Standard_EXPORT void | Compute (const Handle(Prs3d_Projector)&aProjector, const Handle(Prs3d_Presentation)&aPresentation)

Calculates the 3D view aPresentation and its
updates. The latter are managed by
aPresentationManager. Each of the views in the
viewer and every modification such as rotation, for
example, entails recalculation.
It must be redefined to implement hidden line removal
for the object. The user never calls this method
himself. This is done via the InteractiveContext object
and is dependent on the point of view from which the
object is displayed.
.

Standard_EXPORT void | Compute (const Handle(PrsMgr_PresentationManager2d)&aPresentationManager, const Handle(Graphic2d_GraphicObject)&aPresentation, const Standard_Integer aMode=0)
| Calculates the 2D view aPresentation and its updates. The latter are managed by aPresentationManager. aPresentableObject has the display mode aMode; this has the default value of 0, that is, the wireframe display mode. Note that this syntax is not used in AIS as that package only concerns 3D display. .
Standard_EXPORT void | ComputeSelection (const Handle(SelectMgr_Selection)&aSelection, const Standard_Integer aMode)

Recovers and calculates any sensitive primitive,
aSelection, available in Shape mode, specified by
aMode. As a rule, these are sensitive faces.
This method is defined as virtual. This enables you to
implement it in the creation of a new class of AIS
Interactive Object. You need to do this and in so
doing, redefine this method, if you create a class
which enriches the list of signatures and types.
.

Standard_EXPORT void | ComputeInfiniteLine (const Handle(Prs3d_Presentation)&aPresentation)
Standard_EXPORT void | ComputeSegmentLine (const Handle(Prs3d_Presentation)&aPresentation)
Standard_EXPORT void | ComputeInfiniteLineSelection (const Handle(SelectMgr_Selection)&aSelection)
Standard_EXPORT void | ComputeSegmentLineSelection (const Handle(SelectMgr_Selection)&aSelection)

## Private Attributes

Handle_Geom_Line | myComponent
Handle_Geom_Point | myStartPoint
Handle_Geom_Point | myEndPoint
Standard_Boolean | myLineIsSegment

## Constructor & Destructor Documentation

Standard_EXPORT AIS_Line::AIS_Line | ( | const Handle(Geom_Line)& | aLine | ) |

Standard_EXPORT AIS_Line::AIS_Line | ( | const Handle(Geom_Point)& | aStartPoint,
|  | const Handle(Geom_Point)& | aEndPoint
| ) |

## Member Function Documentation

Standard_EXPORT void AIS_Line::Compute | ( | const Handle(PrsMgr_PresentationManager2d)& | aPresentationManager,
|  | const Handle(Graphic2d_GraphicObject)& | aPresentation,
|  | const Standard_Integer | aMode = `0`
| ) | `[private, virtual]`

| Reimplemented from PrsMgr_PresentableObject.

Standard_EXPORT void AIS_Line::Compute | ( | const Handle(Prs3d_Projector)& | aProjector,
|  | const Handle(Prs3d_Presentation)& | aPresentation
| ) | `[private, virtual]`

| Reimplemented from PrsMgr_PresentableObject.

Standard_EXPORT void AIS_Line::Compute | ( | const Handle(PrsMgr_PresentationManager3d)& | aPresentationManager,
|  | const Handle(Prs3d_Presentation)& | aPresentation,
|  | const Standard_Integer | aMode = `0`
| ) | `[private, virtual]`

| Reimplemented from PrsMgr_PresentableObject.

virtual Standard_EXPORT void AIS_Line::Compute | ( | const Handle(Prs3d_Projector)& | aProjector,
|  | const Handle(Geom_Transformation)& | aTrsf,
|  | const Handle(Prs3d_Presentation)& | aPresentation
| ) | `[virtual]`

| Reimplemented from PrsMgr_PresentableObject.

Standard_EXPORT void AIS_Line::ComputeInfiniteLine | ( | const Handle(Prs3d_Presentation)& | aPresentation | ) | `[private]`

Standard_EXPORT void AIS_Line::ComputeInfiniteLineSelection | ( | const Handle(SelectMgr_Selection)& | aSelection | ) | `[private]`

Standard_EXPORT void AIS_Line::ComputeSegmentLine | ( | const Handle(Prs3d_Presentation)& | aPresentation | ) | `[private]`

Standard_EXPORT void AIS_Line::ComputeSegmentLineSelection | ( | const Handle(SelectMgr_Selection)& | aSelection | ) | `[private]`

Standard_EXPORT void AIS_Line::ComputeSelection | ( | const Handle(SelectMgr_Selection)& | aSelection,
|  | const Standard_Integer | aMode
| ) | `[private, virtual]`

| Implements SelectMgr_SelectableObject.

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

| Reimplemented from AIS_InteractiveObject.

const Handle_Geom_Line& AIS_Line::Line | ( |  | ) | const

void AIS_Line::Points | ( | Handle(Geom_Point)& | PStart,
|  | Handle(Geom_Point)& | PEnd
| ) | const`[inline]`

Standard_EXPORT void AIS_Line::SetColor | ( | const Quantity_Color & | aColor | ) | `[virtual]`

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Line::SetColor | ( | const Quantity_NameOfColor | aColor | ) | `[virtual]`

| Reimplemented from AIS_InteractiveObject.

void AIS_Line::SetLine | ( | const Handle(Geom_Line)& | L | ) | `[inline]`

void AIS_Line::SetPoints | ( | const Handle(Geom_Point)& | P1,
|  | const Handle(Geom_Point)& | P2
| ) | `[inline]`

Standard_EXPORT void AIS_Line::SetWidth | ( | const Standard_Real | aValue | ) | `[virtual]`

| Reimplemented from AIS_InteractiveObject.

Standard_Integer AIS_Line::Signature | ( |  | ) | const`[inline, virtual]`

| Reimplemented from AIS_InteractiveObject.

AIS_KindOfInteractive AIS_Line::Type | ( |  | ) | const`[inline, virtual]`

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Line::UnsetColor | ( |  | ) | `[virtual]`

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Line::UnsetWidth | ( |  | ) | `[virtual]`

| Reimplemented from AIS_InteractiveObject.

## Field Documentation

Handle_Geom_Line AIS_Line::myComponent `[private]`

Handle_Geom_Point AIS_Line::myEndPoint `[private]`

Standard_Boolean AIS_Line::myLineIsSegment `[private]`

Handle_Geom_Point AIS_Line::myStartPoint `[private]`

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

- AIS_Line.hxx
- AIS_Line.lxx