Open CASCADE Technology 6.6.0
Public Member Functions
AIS_Trihedron Class Reference

Create a selectable trihedron
there are 4 modes of selection :
mode = 0 to select triedron ,priority = 1
mode = 1 to select its origine ,priority = 5
mode = 2 to select its axis ,priority = 3
mode = 3 to select its planes ,priority = 2
a trihedron has 1 origine,3 axes,3 planes.
Warning
For the presentation of trihedra, the default unit of
length is the millimetre, and the default value for the
representation of the axes is 100. If you modify these
dimensions, you must temporarily recover the Drawer.
From inside it, you take the aspect in which the values
for length are stocked. For trihedra, this is
AIS_Drawer_FirstAxisAspect. You change the
values inside this Aspect and recalculate the presentation.
If you want to use extended selection modes, different than 0,
you should take care of removing of the shapes from the interactive
context that has been computed for selection; it might be necessary
when you change selection mode. You can use methods Axis, Point,
Plane to retrieve the shapes.

#include <AIS_Trihedron.hxx>

Inheritance diagram for AIS_Trihedron:
Inheritance graph
[legend]

Public Member Functions

 AIS_Trihedron (const Handle< Geom_Axis2Placement > &aComponent)
 Initializes a trihedron entity.

const Handle_Geom_Axis2Placement & Component () const
 Returns the right-handed coordinate system set in SetComponent.

void SetComponent (const Handle< Geom_Axis2Placement > &aComponent)
 Constructs the right-handed coordinate system aComponent.

Standard_Boolean HasOwnSize () const
 Returns true if the trihedron object has a size other
than the default size of 100 mm. along each axis.

void SetSize (const Standard_Real aValue)
 Sets the size aValue for the trihedron object.
The default value is 100 mm.

void UnsetSize ()
 Removes any non-default settings for size of this
trihedron object.

Standard_Real Size () const
Handle_AIS_Axis XAxis () const
 Returns the "XAxis".

Handle_AIS_Axis YAxis () const
 Returns the "YAxis".

Handle_AIS_Axis Axis () const
 Returns the main Axis.

Handle_AIS_Point Position () const
 Returns the origine.

Handle_AIS_Plane XYPlane () const
 Returns the "XYPlane".

Handle_AIS_Plane XZPlane () const
 Returns the "XZPlane".

Handle_AIS_Plane YZPlane () const
 Returns the "YZPlane".

virtual void SetContext (const Handle< AIS_InteractiveContext > &aCtx)
 connection to <aCtx> default drawer implies a recomputation
of SubObjects values.

Standard_Boolean AcceptDisplayMode (const Standard_Integer aMode) const
 Returns true if the display mode selected, aMode, is
valid for trihedron datums.

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

void SetLocation (const TopLoc_Location &aLoc)
virtual Standard_Integer Signature () const
 Returns index 3, selection of the planes XOY, YOZ, XOZ.

virtual AIS_KindOfInteractive Type () const
 Indicates that the type of Interactive Object is datum.

void SetColor (const Quantity_NameOfColor aColor)
 only the interactive obj knowns which Drawer attribute
is affected by the color (ex: for a wire, it's the
wireaspect field of the drawer, but for a vertex, only
the point aspect field is affected by the color)
WARNING : Do not forget to set the corresponding fields
here (hasOwnColor and myOwnColor)

void SetColor (const Quantity_Color &aColor)
 Sets the color aColor for this trihedron object.

void SetTextColor (const Quantity_NameOfColor aColor)
Standard_Boolean HasTextColor () const
Quantity_NameOfColor TextColor () const
void SetArrowColor (const Quantity_NameOfColor aColor)
Standard_Boolean HasArrowColor () const
Quantity_NameOfColor ArrowColor () const
void ExtremityPoints (TColgp_Array1OfPnt &TheExtrem) const
 Returns the four extremities of the trihedron from the
array of points, TheExtrem.

void UnsetColor ()
 Removes the settings for color.

void UnsetWidth ()
 Removes the non-default settings for width set in SetWidth.


Constructor & Destructor Documentation

AIS_Trihedron::AIS_Trihedron ( const Handle< Geom_Axis2Placement > &  aComponent)

Member Function Documentation

Standard_Boolean AIS_Trihedron::AcceptDisplayMode ( const Standard_Integer  aMode) const [virtual]

Reimplemented from AIS_InteractiveObject.

Quantity_NameOfColor AIS_Trihedron::ArrowColor ( ) const
Handle_AIS_Axis AIS_Trihedron::Axis ( ) const
const Handle_Geom_Axis2Placement& AIS_Trihedron::Component ( ) const
virtual void AIS_Trihedron::Compute ( const Handle< Prs3d_Projector > &  aProjector,
const Handle< Geom_Transformation > &  aTrsf,
const Handle< Prs3d_Presentation > &  aPresentation 
) [virtual]

Reimplemented from PrsMgr_PresentableObject.

void AIS_Trihedron::ExtremityPoints ( TColgp_Array1OfPnt TheExtrem) const
Standard_Boolean AIS_Trihedron::HasArrowColor ( ) const
Standard_Boolean AIS_Trihedron::HasOwnSize ( ) const
Standard_Boolean AIS_Trihedron::HasTextColor ( ) const
Handle_AIS_Point AIS_Trihedron::Position ( ) const
void AIS_Trihedron::SetArrowColor ( const Quantity_NameOfColor  aColor)
void AIS_Trihedron::SetColor ( const Quantity_NameOfColor  aColor) [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Trihedron::SetColor ( const Quantity_Color aColor) [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Trihedron::SetComponent ( const Handle< Geom_Axis2Placement > &  aComponent)
virtual void AIS_Trihedron::SetContext ( const Handle< AIS_InteractiveContext > &  aCtx) [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Trihedron::SetLocation ( const TopLoc_Location aLoc) [virtual]

Reimplemented from PrsMgr_PresentableObject.

void AIS_Trihedron::SetSize ( const Standard_Real  aValue)
void AIS_Trihedron::SetTextColor ( const Quantity_NameOfColor  aColor)
virtual Standard_Integer AIS_Trihedron::Signature ( ) const [virtual]

Reimplemented from AIS_InteractiveObject.

Standard_Real AIS_Trihedron::Size ( ) const
Quantity_NameOfColor AIS_Trihedron::TextColor ( ) const
virtual AIS_KindOfInteractive AIS_Trihedron::Type ( ) const [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Trihedron::UnsetColor ( ) [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Trihedron::UnsetSize ( )
void AIS_Trihedron::UnsetWidth ( ) [virtual]

Reimplemented from AIS_InteractiveObject.

Handle_AIS_Axis AIS_Trihedron::XAxis ( ) const
Handle_AIS_Plane AIS_Trihedron::XYPlane ( ) const
Handle_AIS_Plane AIS_Trihedron::XZPlane ( ) const
Handle_AIS_Axis AIS_Trihedron::YAxis ( ) const
Handle_AIS_Plane AIS_Trihedron::YZPlane ( ) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines