# Visualization
TKV3d
AIS

# AIS_PlaneTrihedron Class Reference

To construct a selectable 2d axis system in a 3d
drawing. This can be placed anywhere in the 3d
system, and provides a coordinate system for
drawing curves and shapes in a plane.
There are 3 selection modes:
- mode 0 selection of the whole plane "trihedron"
- mode 1 selection of the origin of the plane "trihedron"
- mode 2 selection of the axes.
Warning
For the presentation of planes and trihedra, the
millimetre is default unit of length, and 100 the default
value for the representation of the axes. If you modify
these dimensions, you must temporarily recover the
Drawer object. From inside it, take the Aspects in
which the values for length are stocked, for example,
PlaneAspect for planes and FirstAxisAspect for
trihedra. Change these values and recalculate the presentation.
.

`#include <AIS_PlaneTrihedron.hxx>`

Inheritance diagram for AIS_PlaneTrihedron:

[legend]

## Public Member Functions

Standard_EXPORT | AIS_PlaneTrihedron (const Handle(Geom_Plane)&aPlane)
| Initializes the plane aPlane. The plane trihedron is constructed from this and an axis. .
Standard_EXPORT Handle_Geom_Plane | Component ()
| Returns the component specified in SetComponent. .
Standard_EXPORT void | SetComponent (const Handle(Geom_Plane)&aPlane)
| Creates an instance of the component object aPlane. .
Standard_EXPORT Handle_AIS_Line | XAxis () const
| Returns the "XAxis". .
Standard_EXPORT Handle_AIS_Line | YAxis () const
| Returns the "YAxis". .
Standard_EXPORT Handle_AIS_Point | Position () const
| Returns the point of origin of the plane trihedron. .
Standard_EXPORT void | SetLength (const Standard_Real theLength)
| Sets the length of the X and Y axes. .
Standard_EXPORT Standard_Real | GetLength () const
| Returns the length of X and Y axes. .
Standard_EXPORT Standard_Boolean | AcceptDisplayMode (const Standard_Integer aMode) const
| Returns true if the display mode selected, aMode, is valid. .
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

Specifies additional characteristics of Interactive
Objects. A signature is, in fact, an index with integer
values assigned different properties.
This method is frequently used in conjuction with
Type to give a particular type and signature to an
Interactive Object. By default, the Interactive Object
has a None type and a signature of 0. Among the
datums, this signature is attributed to the shape
The remaining datums have the following default signatures:
- Point signature 1
- Axis signature 2
- Trihedron signature 3
- PlaneTrihedron signature 4
- Line signature 5
- Circle signature 6
- Plane signature 7.
.

virtual AIS_KindOfInteractive | Type () const
| Returns datum as the type of Interactive Object. .
Standard_EXPORT void | SetColor (const Quantity_NameOfColor aColor)
| Allows you to provide settings for the color aColor. .
Standard_EXPORT void | SetColor (const Quantity_Color &aColor)
void | SetXLabel (const TCollection_AsciiString &aLabel)
void | SetYLabel (const TCollection_AsciiString &aLabel)
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Protected Member Functions

virtual 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. .

## Private Member Functions

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.
.

## Private Attributes

Handle_Geom_Plane | myPlane
Handle_AIS_InteractiveObject | myShapes [3]
TCollection_AsciiString | myXLabel
TCollection_AsciiString | myYLabel

## Constructor & Destructor Documentation

Standard_EXPORT AIS_PlaneTrihedron::AIS_PlaneTrihedron | ( | const Handle(Geom_Plane)& | aPlane | ) |

## Member Function Documentation

Standard_EXPORT Standard_Boolean AIS_PlaneTrihedron::AcceptDisplayMode | ( | const Standard_Integer | aMode | ) | const`[virtual]`

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT Handle_Geom_Plane AIS_PlaneTrihedron::Component | ( |  | ) |

Standard_EXPORT void AIS_PlaneTrihedron::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_PlaneTrihedron::Compute | ( | const Handle(Prs3d_Projector)& | aProjector,
|  | const Handle(Prs3d_Presentation)& | aPresentation
| ) | `[private, virtual]`

| Reimplemented from PrsMgr_PresentableObject.

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

| Reimplemented from PrsMgr_PresentableObject.

virtual Standard_EXPORT void AIS_PlaneTrihedron::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_PlaneTrihedron::ComputeSelection | ( | const Handle(SelectMgr_Selection)& | aSelection,
|  | const Standard_Integer | aMode
| ) | `[private, virtual]`

| Implements SelectMgr_SelectableObject.

Standard_EXPORT Standard_Real AIS_PlaneTrihedron::GetLength | ( |  | ) | const

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

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT Handle_AIS_Point AIS_PlaneTrihedron::Position | ( |  | ) | const

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

| Reimplemented from AIS_InteractiveObject.

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

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_PlaneTrihedron::SetComponent | ( | const Handle(Geom_Plane)& | aPlane | ) |

Standard_EXPORT void AIS_PlaneTrihedron::SetLength | ( | const Standard_Real | theLength | ) |

void AIS_PlaneTrihedron::SetXLabel | ( | const TCollection_AsciiString & | aLabel | ) | `[inline]`

void AIS_PlaneTrihedron::SetYLabel | ( | const TCollection_AsciiString & | aLabel | ) | `[inline]`

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

| Reimplemented from AIS_InteractiveObject.

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

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT Handle_AIS_Line AIS_PlaneTrihedron::XAxis | ( |  | ) | const

Standard_EXPORT Handle_AIS_Line AIS_PlaneTrihedron::YAxis | ( |  | ) | const

## Field Documentation

Handle_Geom_Plane AIS_PlaneTrihedron::myPlane `[private]`

Handle_AIS_InteractiveObject AIS_PlaneTrihedron::myShapes[3]`[private]`

TCollection_AsciiString AIS_PlaneTrihedron::myXLabel `[private]`

TCollection_AsciiString AIS_PlaneTrihedron::myYLabel `[private]`

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

- AIS_PlaneTrihedron.hxx
- AIS_PlaneTrihedron.lxx