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

Visualization
TKV3d
AIS


AIS_Circle Class Reference

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

#include <AIS_Circle.hxx>

Inheritance diagram for AIS_Circle:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT AIS_Circle (const Handle(Geom_Circle)&aCircle)
 Initializes this algorithm for constructing AIS circle
datums initializes the circle aCircle
.
Standard_EXPORT AIS_Circle (const Handle(Geom_Circle)&aCircle, const Standard_Real aUStart, const Standard_Real aUEnd, const Standard_Boolean aSens=Standard_True)
 Initializes this algorithm for constructing AIS circle datums.
Initializes the circle aCircle, the arc
starting point UStart, the arc ending point UEnd,
and the direction aSens.
.
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 index 6 by default.
.
virtual AIS_KindOfInteractive Type () const
 Indicates that the type of Interactive Object is a datum.
.
const Handle_Geom_Circle & Circle () const
 Returns the circle component defined in SetCircle.
.
void Parameters (Standard_Real &u1, Standard_Real &u2) const
 Constructs instances of the starting point and the end
point parameters, u1 and u2.
.
void SetCircle (const Handle(Geom_Circle)&aCircle)
 Allows you to provide settings for the circle datum aCircle.
.
void SetFirstParam (const Standard_Real u)
 Allows you to set the parameter u for the starting point of an arc.
.
void SetLastParam (const Standard_Real u)
 Allows you to provide the parameter u for the end point of an arc.
.
Standard_EXPORT void SetColor (const Quantity_NameOfColor aColor)
 Assigns the color aColor to the solid line boundary of the circle datum.
.
Standard_EXPORT void SetColor (const Quantity_Color &aColor)
Standard_EXPORT void SetWidth (const Standard_Real aValue)
 Assigns the width aValue to the solid line boundary of the circle datum.
.
Standard_EXPORT void UnsetColor ()
 Removes color from the solid line boundary of the circle datum.
.
Standard_EXPORT void UnsetWidth ()
 Removes width settings from the solid line boundary of the circle datum.
.
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 ComputeCircle (const Handle(Prs3d_Presentation)&aPresentation)
Standard_EXPORT void ComputeArc (const Handle(Prs3d_Presentation)&aPresentation)
Standard_EXPORT void ComputeCircleSelection (const Handle(SelectMgr_Selection)&aSelection)
Standard_EXPORT void ComputeArcSelection (const Handle(SelectMgr_Selection)&aSelection)

Private Attributes

Handle_Geom_Circle myComponent
Standard_Real myUStart
Standard_Real myUEnd
Standard_Boolean myCircleIsArc
Standard_Boolean mySens

Constructor & Destructor Documentation

Standard_EXPORT AIS_Circle::AIS_Circle const Handle(Geom_Circle)&  aCircle  ) 
 

Standard_EXPORT AIS_Circle::AIS_Circle const Handle(Geom_Circle)&  aCircle,
const Standard_Real  aUStart,
const Standard_Real  aUEnd,
const Standard_Boolean  aSens = Standard_True
 


Member Function Documentation

const Handle_Geom_Circle& AIS_Circle::Circle  )  const
 

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

Reimplemented from PrsMgr_PresentableObject.

Standard_EXPORT void AIS_Circle::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_Circle::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_Circle::ComputeArc const Handle(Prs3d_Presentation)&  aPresentation  )  [private]
 

Standard_EXPORT void AIS_Circle::ComputeArcSelection const Handle(SelectMgr_Selection)&  aSelection  )  [private]
 

Standard_EXPORT void AIS_Circle::ComputeCircle const Handle(Prs3d_Presentation)&  aPresentation  )  [private]
 

Standard_EXPORT void AIS_Circle::ComputeCircleSelection const Handle(SelectMgr_Selection)&  aSelection  )  [private]
 

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

Implements SelectMgr_SelectableObject.

Standard_EXPORT const AIS_Circle::Handle Standard_Type   )  const
 

Reimplemented from AIS_InteractiveObject.

void AIS_Circle::Parameters Standard_Real &  u1,
Standard_Real &  u2
const [inline]
 

void AIS_Circle::SetCircle const Handle(Geom_Circle)&  aCircle  )  [inline]
 

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

Reimplemented from AIS_InteractiveObject.

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

Reimplemented from AIS_InteractiveObject.

void AIS_Circle::SetFirstParam const Standard_Real  u  )  [inline]
 

void AIS_Circle::SetLastParam const Standard_Real  u  )  [inline]
 

Standard_EXPORT void AIS_Circle::SetWidth const Standard_Real  aValue  )  [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_Integer AIS_Circle::Signature  )  const [inline, virtual]
 

Reimplemented from AIS_InteractiveObject.

AIS_KindOfInteractive AIS_Circle::Type  )  const [inline, virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Circle::UnsetColor  )  [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Circle::UnsetWidth  )  [virtual]
 

Reimplemented from AIS_InteractiveObject.


Field Documentation

Standard_Boolean AIS_Circle::myCircleIsArc [private]
 

Handle_Geom_Circle AIS_Circle::myComponent [private]
 

Standard_Boolean AIS_Circle::mySens [private]
 

Standard_Real AIS_Circle::myUEnd [private]
 

Standard_Real AIS_Circle::myUStart [private]
 


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