OCC Main Page | Visualization | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

Visualization
TKV3d
AIS


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.

.

#include <AIS_Trihedron.hxx>

Inheritance diagram for AIS_Trihedron:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT 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.
.
Standard_EXPORT 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.
.
Standard_EXPORT void SetSize (const Standard_Real aValue)
 Sets the size aValue for the trihedron object.
The default value is 100 mm.
.
Standard_EXPORT void UnsetSize ()
 Removes any non-default settings for size of this
trihedron object.
.
Standard_EXPORT Standard_Real Size () const
Standard_EXPORT Handle_AIS_Axis XAxis () const
 Returns the "XAxis".
.
Standard_EXPORT Handle_AIS_Axis YAxis () const
 Returns the "YAxis".
.
Standard_EXPORT Handle_AIS_Axis Axis () const
 Returns the main Axis.
.
Standard_EXPORT Handle_AIS_Point Position () const
 Returns the origine.
.
Standard_EXPORT Handle_AIS_Plane XYPlane () const
 Returns the "XYPlane".
.
Standard_EXPORT Handle_AIS_Plane XZPlane () const
 Returns the "XZPlane".
.
Standard_EXPORT Handle_AIS_Plane YZPlane () const
 Returns the "YZPlane".
.
virtual Standard_EXPORT void SetContext (const Handle(AIS_InteractiveContext)&aCtx)
 connection to <actx> default drawer implies a recomputation
of SubObjects values.

Standard_EXPORT Standard_Boolean AcceptDisplayMode (const Standard_Integer aMode) const
 Returns true if the display mode selected, aMode, is
valid for trihedron datums.
.
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_EXPORT Standard_Integer Signature () const
 Returns index 3, selection of the planes XOY, YOZ, XOZ.
.
virtual Standard_EXPORT AIS_KindOfInteractive Type () const
 Indicates that the type of Interactive Object is datum.
.
Standard_EXPORT 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)

Standard_EXPORT void SetColor (const Quantity_Color &aColor)
 Sets the color aColor for this trihedron object.
.
Standard_EXPORT void SetTextColor (const Quantity_NameOfColor aColor)
Standard_EXPORT Standard_Boolean HasTextColor () const
Standard_EXPORT Quantity_NameOfColor TextColor () const
Standard_EXPORT void SetArrowColor (const Quantity_NameOfColor aColor)
Standard_EXPORT Standard_Boolean HasArrowColor () const
Standard_EXPORT Quantity_NameOfColor ArrowColor () const
Standard_EXPORT void ExtremityPoints (TColgp_Array1OfPnt &TheExtrem) const
 Returns the four extremities of the trihedron from the
array of points, TheExtrem.
.
Standard_EXPORT void UnsetColor ()
 Removes the settings for color.
.
Standard_EXPORT void UnsetWidth ()
 Removes the non-default settings for width set in SetWidth.
.
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 LoadSubObjects ()

Private Attributes

Handle_Geom_Axis2Placement myComponent
Handle_AIS_InteractiveObject myShapes [7]
Standard_Boolean myHasOwnSize
Standard_Boolean myHasOwnTextColor
Quantity_NameOfColor myOwnTextColor
Standard_Boolean myHasOwnArrowColor
Quantity_NameOfColor myOwnArrowColor

Constructor & Destructor Documentation

Standard_EXPORT AIS_Trihedron::AIS_Trihedron const Handle(Geom_Axis2Placement)&  aComponent  ) 
 


Member Function Documentation

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

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT Quantity_NameOfColor AIS_Trihedron::ArrowColor  )  const
 

Standard_EXPORT Handle_AIS_Axis AIS_Trihedron::Axis  )  const
 

const Handle_Geom_Axis2Placement& AIS_Trihedron::Component  )  const
 

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

Reimplemented from PrsMgr_PresentableObject.

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

Implements SelectMgr_SelectableObject.

Standard_EXPORT void AIS_Trihedron::ExtremityPoints TColgp_Array1OfPnt &  TheExtrem  )  const
 

Standard_EXPORT const AIS_Trihedron::Handle Standard_Type   )  const
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT Standard_Boolean AIS_Trihedron::HasArrowColor  )  const
 

Standard_Boolean AIS_Trihedron::HasOwnSize  )  const [inline]
 

Standard_EXPORT Standard_Boolean AIS_Trihedron::HasTextColor  )  const
 

Standard_EXPORT void AIS_Trihedron::LoadSubObjects  )  [private]
 

Standard_EXPORT Handle_AIS_Point AIS_Trihedron::Position  )  const
 

Standard_EXPORT void AIS_Trihedron::SetArrowColor const Quantity_NameOfColor  aColor  ) 
 

Standard_EXPORT void AIS_Trihedron::SetColor const Quantity_Color &  aColor  )  [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Trihedron::SetColor const Quantity_NameOfColor  aColor  )  [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Trihedron::SetComponent const Handle(Geom_Axis2Placement)&  aComponent  ) 
 

virtual Standard_EXPORT void AIS_Trihedron::SetContext const Handle(AIS_InteractiveContext)&  aCtx  )  [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Trihedron::SetSize const Standard_Real  aValue  ) 
 

Standard_EXPORT void AIS_Trihedron::SetTextColor const Quantity_NameOfColor  aColor  ) 
 

virtual Standard_EXPORT Standard_Integer AIS_Trihedron::Signature  )  const [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT Standard_Real AIS_Trihedron::Size  )  const
 

Standard_EXPORT Quantity_NameOfColor AIS_Trihedron::TextColor  )  const
 

virtual Standard_EXPORT AIS_KindOfInteractive AIS_Trihedron::Type  )  const [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Trihedron::UnsetColor  )  [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Trihedron::UnsetSize  ) 
 

Standard_EXPORT void AIS_Trihedron::UnsetWidth  )  [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT Handle_AIS_Axis AIS_Trihedron::XAxis  )  const
 

Standard_EXPORT Handle_AIS_Plane AIS_Trihedron::XYPlane  )  const
 

Standard_EXPORT Handle_AIS_Plane AIS_Trihedron::XZPlane  )  const
 

Standard_EXPORT Handle_AIS_Axis AIS_Trihedron::YAxis  )  const
 

Standard_EXPORT Handle_AIS_Plane AIS_Trihedron::YZPlane  )  const
 


Field Documentation

Handle_Geom_Axis2Placement AIS_Trihedron::myComponent [private]
 

Standard_Boolean AIS_Trihedron::myHasOwnArrowColor [private]
 

Standard_Boolean AIS_Trihedron::myHasOwnSize [private]
 

Standard_Boolean AIS_Trihedron::myHasOwnTextColor [private]
 

Quantity_NameOfColor AIS_Trihedron::myOwnArrowColor [private]
 

Quantity_NameOfColor AIS_Trihedron::myOwnTextColor [private]
 

Handle_AIS_InteractiveObject AIS_Trihedron::myShapes[7] [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:55:20 2008 for OpenCASCADE by  doxygen 1.4.1