EIC code displayed by LXR master/​include/​opencascade/​IGESData_ToolLocation.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-09-23 09:17:53

 // Created on: 1993-09-21
 // Created by: Christian CAILLET
 // Copyright (c) 1993-1999 Matra Datavision
 // Copyright (c) 1999-2014 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef _IGESData_ToolLocation_HeaderFile
 #define _IGESData_ToolLocation_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_Type.hxx>
 
 #include <Interface_GeneralLib.hxx>
 #include <Standard_Integer.hxx>
 #include <NCollection_Array1.hxx>
 #include <Standard_Transient.hxx>
 class IGESData_IGESModel;
 class IGESData_Protocol;
 class IGESData_IGESEntity;
 class gp_GTrsf;
 class gp_Trsf;
 
 //! 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
 class IGESData_ToolLocation : public Standard_Transient
 {
 
 public:
   //! 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 IGESData_ToolLocation(const occ::handle<IGESData_IGESModel>& amodel,
                                         const occ::handle<IGESData_Protocol>&  protocol);
 
   //! Does the effective work of determining Locations of Entities
   Standard_EXPORT void Load();
 
   //! Sets a precision for the Analysis of Locations
   //! (default by constructor is 1.E-05)
   Standard_EXPORT void SetPrecision(const double prec);
 
   //! Sets the "Reference" information for <child> as being <parent>
   //! Sets an Error Status if already set (see method IsAmbiguous)
   Standard_EXPORT void SetReference(const occ::handle<IGESData_IGESEntity>& parent,
                                     const occ::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 SetParentAssoc(const occ::handle<IGESData_IGESEntity>& parent,
                                       const occ::handle<IGESData_IGESEntity>& child);
 
   //! Resets all information about dependences for <child>
   Standard_EXPORT void ResetDependences(const occ::handle<IGESData_IGESEntity>& child);
 
   //! 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 void SetOwnAsDependent(const occ::handle<IGESData_IGESEntity>& ent);
 
   //! Returns True if <ent> is kind of TransfEntity. Then, it has
   //! no location, while it can be used to define a Location)
   Standard_EXPORT bool IsTransf(const occ::handle<IGESData_IGESEntity>& ent) const;
 
   //! Returns True if <ent> is an Associativity (IGES Type 402).
   //! Then, Location does not apply.
   Standard_EXPORT bool IsAssociativity(const occ::handle<IGESData_IGESEntity>& ent) const;
 
   //! Returns True if <ent> has a Transformation Matrix in proper
   //! (referenced from its Directory Part)
   Standard_EXPORT bool HasTransf(const occ::handle<IGESData_IGESEntity>& ent) const;
 
   //! Returns the Explicit Location defined by the Transformation
   //! Matrix of <ent>. Identity if there is none
   Standard_EXPORT gp_GTrsf ExplicitLocation(const occ::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 bool IsAmbiguous(const occ::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 bool HasParent(const occ::handle<IGESData_IGESEntity>& ent) const;
 
   //! Returns the unique Parent recorded for <ent>.
   //! Returns a Null Handle if there is none
   Standard_EXPORT occ::handle<IGESData_IGESEntity> Parent(
     const occ::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 bool HasParentByAssociativity(const occ::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 ParentLocation(const occ::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 gp_GTrsf EffectiveLocation(const occ::handle<IGESData_IGESEntity>& ent) 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 bool AnalyseLocation(const gp_GTrsf& loc, gp_Trsf& result) const;
 
   //! Conversion 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
   Standard_EXPORT static bool ConvertLocation(const double    prec,
                                               const gp_GTrsf& loc,
                                               gp_Trsf&        result,
                                               const double    uni = 1);
 
   DEFINE_STANDARD_RTTIEXT(IGESData_ToolLocation, Standard_Transient)
 
 private:
   double                          theprec;
   occ::handle<IGESData_IGESModel> themodel;
   Interface_GeneralLib            thelib;
   NCollection_Array1<int>         therefs;
   NCollection_Array1<int>         theassocs;
 };
 
 #endif // _IGESData_ToolLocation_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team