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

DataExchange
TKIGES
IGESData


IGESData_ToolLocation Class Reference

This Tool determines and gives access to effective Locations
of IGES Entities as defined by the IGES Norm. These Locations
can be for each Entity :
- on one part, explicitly defined by a Transf in Directory
Part (this Transf can be itself compound); if not defined,
no proper Transformation is defined
- on the other part, implicitly defined by a reference from
another Entity : its Parent
Both implicit and explicit locations are combinable.

Implicit definition can be itself defined, either through the
definition of an Entity (i.e. a Composite Curve references
a list of Curves), or by a specific Associativity, of type
SingleParentEntity, by which the Location of the Parent is
applied to the Childs defined by this Associativity.
Remark that a Transf itself has no Location, but it can be
compound

This is a TShared object, then it is easier to use in an
interactive session
.

#include <IGESData_ToolLocation.hxx>


Public Member Functions

Standard_EXPORT IGESData_ToolLocation (const Handle(IGESData_IGESModel)&amodel, const Handle(IGESData_Protocol)&protocol)
 Creates a ToolLocation on a given Model, filled with the help
of a Protocol (which allows to known Entities referenced by
other ones)
.
Standard_EXPORT void Load ()
 Does the effective work of determining Locations of Entities
.
Standard_EXPORT void SetPrecision (const Standard_Real prec)
 Sets a precision for the Analysis of Locations
(default by constructor is 1.E-05)
.
Standard_EXPORT void SetReference (const Handle(IGESData_IGESEntity)&parent, const Handle(IGESData_IGESEntity)&child)
 Sets the "Reference" information for <child> as being <parent>
Sets an Error Status if already set (see method IsAmbiguous)
.
Standard_EXPORT void SetParentAssoc (const Handle(IGESData_IGESEntity)&parent, const Handle(IGESData_IGESEntity)&child)
 Sets the "Associativity" information for <child> as being
<parent> (it must be the Parent itself, not the Associativity)
.
Standard_EXPORT void ResetDependences (const Handle(IGESData_IGESEntity)&child)
 Resets all informations about dependences for <child>
.
Standard_EXPORT void SetOwnAsDependent (const Handle(IGESData_IGESEntity)&ent)
 Unitary action which defines Entities referenced by <ent>
(except those in Directory Part and Associativities List)
as Dependent (their Locations are related to that of <ent>)
.
Standard_EXPORT Standard_Boolean IsTransf (const Handle(IGESData_IGESEntity)&ent) const
 Returns True if <ent> is kind of TransfEntity. Then, it has
no location, while it can be used to define a Location)
.
Standard_EXPORT Standard_Boolean IsAssociativity (const Handle(IGESData_IGESEntity)&ent) const
 Returns True if <ent> is an Associativity (IGES Type 402).
Then, Location does not apply.
.
Standard_EXPORT Standard_Boolean HasTransf (const Handle(IGESData_IGESEntity)&ent) const
 Returns True if <ent> has a Transformation Matrix in proper
(referenced from its Directory Part)
.
Standard_EXPORT gp_GTrsf ExplicitLocation (const Handle(IGESData_IGESEntity)&ent) const
 Returns the Explicit Location defined by the Transformation
Matrix of <ent>. Identity if there is none
.
Standard_EXPORT Standard_Boolean IsAmbiguous (const Handle(IGESData_IGESEntity)&ent) const
 Returns True if more than one Parent has been determined for
<ent>, by adding direct References and Associativities
.
Standard_EXPORT Standard_Boolean HasParent (const Handle(IGESData_IGESEntity)&ent) const
 Returns True if <ent> is dependent from one and only one other
Entity, either by Reference or by Associativity
.
Standard_EXPORT Handle_IGESData_IGESEntity Parent (const Handle(IGESData_IGESEntity)&ent) const
 Returns the unique Parent recorded for <ent>.
Returns a Null Handle if there is none
.
Standard_EXPORT Standard_Boolean HasParentByAssociativity (const Handle(IGESData_IGESEntity)&ent) const
 Returns True if the Parent, if there is one, is defined by
a SingleParentEntity Associativity
Else, if HasParent is True, it is by Reference
.
Standard_EXPORT gp_GTrsf ParentLocation (const Handle(IGESData_IGESEntity)&ent) const
 Returns the effective Location of the Parent of <ent>, if
there is one : this Location is itself given as compound
according dependences on the Parent, if there are some.
Returns an Identity Transformation if no Parent is recorded.
.
Standard_EXPORT gp_GTrsf EffectiveLocation (const Handle(IGESData_IGESEntity)&ent) const
 Returns the effective Location of an Entity, i.e. the
composition of its proper Transformation Matrix (returned by
Transf) and its Parent's Location (returned by ParentLocation)
.
Standard_EXPORT Standard_Boolean AnalyseLocation (const gp_GTrsf &loc, gp_Trsf &result) const
 Analysis a Location given as a GTrsf, by trying to convert it
to a Trsf (i.e. to a True Location of which effect is
described by an Isometry or a Similarity)
Works with the Precision given by default or by SetPrecision
Calls ConvertLocation (see below)
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Static Public Member Functions

static Standard_EXPORT Standard_Boolean ConvertLocation (const Standard_Real prec, const gp_GTrsf &loc, gp_Trsf &result, const Standard_Real uni=1)
 Convertion of a Location, from GTrsf form to Trsf form
Works with a precision given as argument.
Returns True if the Conversion is possible, (hence, <result>
contains the converted location), False else
<unit>, if given, indicates the unit in which <loc> is defined
in meters. It concerns the translation part (to be converted.

As a class method, it can be called separately
.

Private Attributes

Standard_Real theprec
Handle_IGESData_IGESModel themodel
Interface_GeneralLib thelib
TColStd_Array1OfInteger therefs
TColStd_Array1OfInteger theassocs


Constructor & Destructor Documentation

Standard_EXPORT IGESData_ToolLocation::IGESData_ToolLocation const Handle(IGESData_IGESModel)&  amodel,
const Handle(IGESData_Protocol)&  protocol
 


Member Function Documentation

Standard_EXPORT Standard_Boolean IGESData_ToolLocation::AnalyseLocation const gp_GTrsf &  loc,
gp_Trsf &  result
const
 

static Standard_EXPORT Standard_Boolean IGESData_ToolLocation::ConvertLocation const Standard_Real  prec,
const gp_GTrsf &  loc,
gp_Trsf &  result,
const Standard_Real  uni = 1
[static]
 

Standard_EXPORT gp_GTrsf IGESData_ToolLocation::EffectiveLocation const Handle(IGESData_IGESEntity)&  ent  )  const
 

Standard_EXPORT gp_GTrsf IGESData_ToolLocation::ExplicitLocation const Handle(IGESData_IGESEntity)&  ent  )  const
 

Standard_EXPORT const IGESData_ToolLocation::Handle Standard_Type   )  const
 

Standard_EXPORT Standard_Boolean IGESData_ToolLocation::HasParent const Handle(IGESData_IGESEntity)&  ent  )  const
 

Standard_EXPORT Standard_Boolean IGESData_ToolLocation::HasParentByAssociativity const Handle(IGESData_IGESEntity)&  ent  )  const
 

Standard_EXPORT Standard_Boolean IGESData_ToolLocation::HasTransf const Handle(IGESData_IGESEntity)&  ent  )  const
 

Standard_EXPORT Standard_Boolean IGESData_ToolLocation::IsAmbiguous const Handle(IGESData_IGESEntity)&  ent  )  const
 

Standard_EXPORT Standard_Boolean IGESData_ToolLocation::IsAssociativity const Handle(IGESData_IGESEntity)&  ent  )  const
 

Standard_EXPORT Standard_Boolean IGESData_ToolLocation::IsTransf const Handle(IGESData_IGESEntity)&  ent  )  const
 

Standard_EXPORT void IGESData_ToolLocation::Load  ) 
 

Standard_EXPORT Handle_IGESData_IGESEntity IGESData_ToolLocation::Parent const Handle(IGESData_IGESEntity)&  ent  )  const
 

Standard_EXPORT gp_GTrsf IGESData_ToolLocation::ParentLocation const Handle(IGESData_IGESEntity)&  ent  )  const
 

Standard_EXPORT void IGESData_ToolLocation::ResetDependences const Handle(IGESData_IGESEntity)&  child  ) 
 

Standard_EXPORT void IGESData_ToolLocation::SetOwnAsDependent const Handle(IGESData_IGESEntity)&  ent  ) 
 

Standard_EXPORT void IGESData_ToolLocation::SetParentAssoc const Handle(IGESData_IGESEntity)&  parent,
const Handle(IGESData_IGESEntity)&  child
 

Standard_EXPORT void IGESData_ToolLocation::SetPrecision const Standard_Real  prec  ) 
 

Standard_EXPORT void IGESData_ToolLocation::SetReference const Handle(IGESData_IGESEntity)&  parent,
const Handle(IGESData_IGESEntity)&  child
 


Field Documentation

TColStd_Array1OfInteger IGESData_ToolLocation::theassocs [private]
 

Interface_GeneralLib IGESData_ToolLocation::thelib [private]
 

Handle_IGESData_IGESModel IGESData_ToolLocation::themodel [private]
 

Standard_Real IGESData_ToolLocation::theprec [private]
 

TColStd_Array1OfInteger IGESData_ToolLocation::therefs [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:40:27 2008 for OpenCASCADE by  doxygen 1.4.1