mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-06 18:26:22 +03:00
0be7dbe183
Added macro Standard_NODISCARD equivalent to C++17 attribute [[nodiscard]] for compilers that support this. Using Standard_NODISCARD macro for methods that create new object in gp, math, Geom, Bnd packages. Marked equivalent operators with Standard_NODISCARD, if they are defined close to relevant methods. Corrected code where warnings on unused result of calls to methods creating new objects are generated. In most cases it looks like spelling errors (e.g. Normalised() instead of Normalise())
202 lines
8.3 KiB
C++
202 lines
8.3 KiB
C++
// Created on: 1993-03-10
|
|
// Created by: JCV
|
|
// 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 _Geom_Transformation_HeaderFile
|
|
#define _Geom_Transformation_HeaderFile
|
|
|
|
#include <gp_Trsf.hxx>
|
|
#include <Standard.hxx>
|
|
#include <Standard_Boolean.hxx>
|
|
#include <Standard_Integer.hxx>
|
|
#include <Standard_Real.hxx>
|
|
#include <Standard_Type.hxx>
|
|
#include <Standard_Transient.hxx>
|
|
|
|
DEFINE_STANDARD_HANDLE(Geom_Transformation, Standard_Transient)
|
|
|
|
//! Describes how to construct the following elementary transformations
|
|
//! - translations,
|
|
//! - rotations,
|
|
//! - symmetries,
|
|
//! - scales.
|
|
//! The Transformation class can also be used to
|
|
//! construct complex transformations by combining these
|
|
//! elementary transformations.
|
|
//! However, these transformations can never change
|
|
//! the type of an object. For example, the projection
|
|
//! transformation can change a circle into an ellipse, and
|
|
//! therefore change the real type of the object. Such a
|
|
//! transformation is forbidden in this environment and
|
|
//! cannot be a Geom_Transformation.
|
|
//! The transformation can be represented as follow :
|
|
//!
|
|
//! V1 V2 V3 T
|
|
//! | a11 a12 a13 a14 | | x | | x'|
|
|
//! | a21 a22 a23 a24 | | y | | y'|
|
|
//! | a31 a32 a33 a34 | | z | = | z'|
|
|
//! | 0 0 0 1 | | 1 | | 1 |
|
|
//!
|
|
//! where {V1, V2, V3} defines the vectorial part of the
|
|
//! transformation and T defines the translation part of
|
|
//! the transformation.
|
|
//! Note: Geom_Transformation transformations
|
|
//! provide the same kind of "geometric" services as
|
|
//! gp_Trsf ones but have more complex data structures.
|
|
//! The geometric objects provided by the Geom
|
|
//! package use gp_Trsf transformations in the syntaxes
|
|
//! Transform and Transformed.
|
|
//! Geom_Transformation transformations are used in
|
|
//! a context where they can be shared by several
|
|
//! objects contained inside a common data structure.
|
|
class Geom_Transformation : public Standard_Transient
|
|
{
|
|
DEFINE_STANDARD_RTTIEXT(Geom_Transformation, Standard_Transient)
|
|
public:
|
|
|
|
//! Creates an identity transformation.
|
|
Standard_EXPORT Geom_Transformation();
|
|
|
|
//! Creates a transient copy of T.
|
|
Standard_EXPORT Geom_Transformation(const gp_Trsf& T);
|
|
|
|
//! Makes the transformation into a symmetrical transformation
|
|
//! with respect to a point P.
|
|
//! P is the center of the symmetry.
|
|
void SetMirror (const gp_Pnt& thePnt) { gpTrsf.SetMirror (thePnt); }
|
|
|
|
//! Makes the transformation into a symmetrical transformation
|
|
//! with respect to an axis A1.
|
|
//! A1 is the center of the axial symmetry.
|
|
void SetMirror (const gp_Ax1& theA1) { gpTrsf.SetMirror (theA1); }
|
|
|
|
//! Makes the transformation into a symmetrical transformation
|
|
//! with respect to a plane. The plane of the symmetry is
|
|
//! defined with the axis placement A2. It is the plane
|
|
//! (Location, XDirection, YDirection).
|
|
void SetMirror (const gp_Ax2& theA2) { gpTrsf.SetMirror (theA2); }
|
|
|
|
//! Makes the transformation into a rotation.
|
|
//! A1 is the axis rotation and Ang is the angular value
|
|
//! of the rotation in radians.
|
|
void SetRotation (const gp_Ax1& theA1, const Standard_Real theAng) { gpTrsf.SetRotation (theA1, theAng); }
|
|
|
|
//! Makes the transformation into a scale. P is the center of
|
|
//! the scale and S is the scaling value.
|
|
void SetScale (const gp_Pnt& thePnt, const Standard_Real theScale) { gpTrsf.SetScale (thePnt, theScale); }
|
|
|
|
//! Makes a transformation allowing passage from the coordinate
|
|
//! system "FromSystem1" to the coordinate system "ToSystem2".
|
|
//! Example :
|
|
//! In a C++ implementation :
|
|
//! Real x1, y1, z1; // are the coordinates of a point in the
|
|
//! // local system FromSystem1
|
|
//! Real x2, y2, z2; // are the coordinates of a point in the
|
|
//! // local system ToSystem2
|
|
//! gp_Pnt P1 (x1, y1, z1)
|
|
//! Geom_Transformation T;
|
|
//! T.SetTransformation (FromSystem1, ToSystem2);
|
|
//! gp_Pnt P2 = P1.Transformed (T);
|
|
//! P2.Coord (x2, y2, z2);
|
|
void SetTransformation (const gp_Ax3& theFromSystem1, const gp_Ax3& theToSystem2) { gpTrsf.SetTransformation (theFromSystem1, theToSystem2); }
|
|
|
|
//! Makes the transformation allowing passage from the basic
|
|
//! coordinate system
|
|
//! {P(0.,0.,0.), VX (1.,0.,0.), VY (0.,1.,0.), VZ (0., 0. ,1.) }
|
|
//! to the local coordinate system defined with the Ax2 ToSystem.
|
|
//! Same utilisation as the previous method. FromSystem1 is
|
|
//! defaulted to the absolute coordinate system.
|
|
void SetTransformation (const gp_Ax3& theToSystem) { gpTrsf.SetTransformation (theToSystem); }
|
|
|
|
//! Makes the transformation into a translation.
|
|
//! V is the vector of the translation.
|
|
void SetTranslation (const gp_Vec& theVec) { gpTrsf.SetTranslation (theVec); }
|
|
|
|
//! Makes the transformation into a translation from the point
|
|
//! P1 to the point P2.
|
|
void SetTranslation (const gp_Pnt& P1, const gp_Pnt& P2) { gpTrsf.SetTranslation (P1, P2); }
|
|
|
|
//! Converts the gp_Trsf transformation T into this transformation.
|
|
void SetTrsf (const gp_Trsf& theTrsf) { gpTrsf = theTrsf; }
|
|
|
|
//! Checks whether this transformation is an indirect
|
|
//! transformation: returns true if the determinant of the
|
|
//! matrix of the vectorial part of the transformation is less than 0.
|
|
Standard_Boolean IsNegative() const { return gpTrsf.IsNegative(); }
|
|
|
|
//! Returns the nature of this transformation as a value
|
|
//! of the gp_TrsfForm enumeration.
|
|
gp_TrsfForm Form() const { return gpTrsf.Form(); }
|
|
|
|
//! Returns the scale value of the transformation.
|
|
Standard_Real ScaleFactor() const { return gpTrsf.ScaleFactor(); }
|
|
|
|
//! Returns a non transient copy of <me>.
|
|
const gp_Trsf& Trsf() const { return gpTrsf; }
|
|
|
|
//! Returns the coefficients of the global matrix of transformation.
|
|
//! It is a 3 rows X 4 columns matrix.
|
|
//!
|
|
//! Raised if Row < 1 or Row > 3 or Col < 1 or Col > 4
|
|
Standard_Real Value (const Standard_Integer theRow, const Standard_Integer theCol) const { return gpTrsf.Value (theRow, theCol); }
|
|
|
|
//! Raised if the the transformation is singular. This means that
|
|
//! the ScaleFactor is lower or equal to Resolution from
|
|
//! package gp.
|
|
void Invert() { gpTrsf.Invert(); }
|
|
|
|
//! Raised if the the transformation is singular. This means that
|
|
//! the ScaleFactor is lower or equal to Resolution from
|
|
//! package gp.
|
|
Standard_EXPORT Standard_NODISCARD Handle(Geom_Transformation) Inverted() const;
|
|
|
|
//! Computes the transformation composed with Other and <me>.
|
|
//! <me> * Other.
|
|
//! Returns a new transformation
|
|
Standard_EXPORT Standard_NODISCARD Handle(Geom_Transformation) Multiplied (const Handle(Geom_Transformation)& Other) const;
|
|
|
|
//! Computes the transformation composed with Other and <me> .
|
|
//! <me> = <me> * Other.
|
|
void Multiply (const Handle(Geom_Transformation)& theOther) { gpTrsf.Multiply (theOther->Trsf()); }
|
|
|
|
//! Computes the following composition of transformations
|
|
//! if N > 0 <me> * <me> * .......* <me>.
|
|
//! if N = 0 Identity
|
|
//! if N < 0 <me>.Invert() * .........* <me>.Invert()
|
|
//!
|
|
//! Raised if N < 0 and if the transformation is not inversible
|
|
void Power (const Standard_Integer N) { gpTrsf.Power (N); }
|
|
|
|
//! Raised if N < 0 and if the transformation is not inversible
|
|
Standard_EXPORT Handle(Geom_Transformation) Powered (const Standard_Integer N) const;
|
|
|
|
//! Computes the matrix of the transformation composed with
|
|
//! <me> and Other. <me> = Other * <me>
|
|
Standard_EXPORT void PreMultiply (const Handle(Geom_Transformation)& Other);
|
|
|
|
//! Applies the transformation <me> to the triplet {X, Y, Z}.
|
|
void Transforms (Standard_Real& theX, Standard_Real& theY, Standard_Real& theZ) const { gpTrsf.Transforms (theX, theY, theZ); }
|
|
|
|
//! Creates a new object which is a copy of this transformation.
|
|
Standard_EXPORT Handle(Geom_Transformation) Copy() const;
|
|
|
|
private:
|
|
|
|
gp_Trsf gpTrsf;
|
|
|
|
};
|
|
|
|
#endif // _Geom_Transformation_HeaderFile
|