mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-04 18:06: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())
170 lines
5.2 KiB
C++
170 lines
5.2 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_VectorWithMagnitude_HeaderFile
|
|
#define _Geom_VectorWithMagnitude_HeaderFile
|
|
|
|
#include <Standard.hxx>
|
|
#include <Standard_Type.hxx>
|
|
|
|
#include <Geom_Vector.hxx>
|
|
#include <Standard_Real.hxx>
|
|
class Standard_ConstructionError;
|
|
class gp_Vec;
|
|
class gp_Pnt;
|
|
class Geom_Vector;
|
|
class gp_Trsf;
|
|
class Geom_Geometry;
|
|
|
|
|
|
class Geom_VectorWithMagnitude;
|
|
DEFINE_STANDARD_HANDLE(Geom_VectorWithMagnitude, Geom_Vector)
|
|
|
|
|
|
//! Defines a vector with magnitude.
|
|
//! A vector with magnitude can have a zero length.
|
|
class Geom_VectorWithMagnitude : public Geom_Vector
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
//! Creates a transient copy of V.
|
|
Standard_EXPORT Geom_VectorWithMagnitude(const gp_Vec& V);
|
|
|
|
//! Creates a vector with three cartesian coordinates.
|
|
Standard_EXPORT Geom_VectorWithMagnitude(const Standard_Real X, const Standard_Real Y, const Standard_Real Z);
|
|
|
|
|
|
//! Creates a vector from the point P1 to the point P2.
|
|
//! The magnitude of the vector is the distance between P1 and P2
|
|
Standard_EXPORT Geom_VectorWithMagnitude(const gp_Pnt& P1, const gp_Pnt& P2);
|
|
|
|
//! Assigns the values X, Y and Z to the coordinates of this vector.
|
|
Standard_EXPORT void SetCoord (const Standard_Real X, const Standard_Real Y, const Standard_Real Z);
|
|
|
|
//! Converts the gp_Vec vector V into this vector.
|
|
Standard_EXPORT void SetVec (const gp_Vec& V);
|
|
|
|
//! Changes the X coordinate of <me>.
|
|
Standard_EXPORT void SetX (const Standard_Real X);
|
|
|
|
//! Changes the Y coordinate of <me>
|
|
Standard_EXPORT void SetY (const Standard_Real Y);
|
|
|
|
//! Changes the Z coordinate of <me>.
|
|
Standard_EXPORT void SetZ (const Standard_Real Z);
|
|
|
|
//! Returns the magnitude of <me>.
|
|
Standard_EXPORT Standard_Real Magnitude() const Standard_OVERRIDE;
|
|
|
|
//! Returns the square magnitude of <me>.
|
|
Standard_EXPORT Standard_Real SquareMagnitude() const Standard_OVERRIDE;
|
|
|
|
|
|
//! Adds the Vector Other to <me>.
|
|
Standard_EXPORT void Add (const Handle(Geom_Vector)& Other);
|
|
|
|
|
|
//! Adds the vector Other to <me>.
|
|
Standard_EXPORT Standard_NODISCARD Handle(Geom_VectorWithMagnitude) Added (const Handle(Geom_Vector)& Other) const;
|
|
|
|
|
|
//! Computes the cross product between <me> and Other
|
|
//! <me> ^ Other.
|
|
Standard_EXPORT void Cross (const Handle(Geom_Vector)& Other) Standard_OVERRIDE;
|
|
|
|
|
|
//! Computes the cross product between <me> and Other
|
|
//! <me> ^ Other. A new vector is returned.
|
|
Standard_EXPORT Handle(Geom_Vector) Crossed (const Handle(Geom_Vector)& Other) const Standard_OVERRIDE;
|
|
|
|
|
|
//! Computes the triple vector product <me> ^ (V1 ^ V2).
|
|
Standard_EXPORT void CrossCross (const Handle(Geom_Vector)& V1, const Handle(Geom_Vector)& V2) Standard_OVERRIDE;
|
|
|
|
|
|
//! Computes the triple vector product <me> ^ (V1 ^ V2).
|
|
//! A new vector is returned.
|
|
Standard_EXPORT Handle(Geom_Vector) CrossCrossed (const Handle(Geom_Vector)& V1, const Handle(Geom_Vector)& V2) const Standard_OVERRIDE;
|
|
|
|
//! Divides <me> by a scalar.
|
|
Standard_EXPORT void Divide (const Standard_Real Scalar);
|
|
|
|
|
|
//! Divides <me> by a scalar. A new vector is returned.
|
|
Standard_EXPORT Standard_NODISCARD Handle(Geom_VectorWithMagnitude) Divided (const Standard_Real Scalar) const;
|
|
|
|
|
|
//! Computes the product of the vector <me> by a scalar.
|
|
//! A new vector is returned.
|
|
Standard_EXPORT Standard_NODISCARD Handle(Geom_VectorWithMagnitude) Multiplied (const Standard_Real Scalar) const;
|
|
|
|
|
|
//! Computes the product of the vector <me> by a scalar.
|
|
Standard_EXPORT void Multiply (const Standard_Real Scalar);
|
|
|
|
//! Normalizes <me>.
|
|
//!
|
|
//! Raised if the magnitude of the vector is lower or equal to
|
|
//! Resolution from package gp.
|
|
Standard_EXPORT void Normalize();
|
|
|
|
//! Returns a copy of <me> Normalized.
|
|
//!
|
|
//! Raised if the magnitude of the vector is lower or equal to
|
|
//! Resolution from package gp.
|
|
Standard_EXPORT Standard_NODISCARD Handle(Geom_VectorWithMagnitude) Normalized() const;
|
|
|
|
//! Subtracts the Vector Other to <me>.
|
|
Standard_EXPORT void Subtract (const Handle(Geom_Vector)& Other);
|
|
|
|
|
|
//! Subtracts the vector Other to <me>. A new vector is returned.
|
|
Standard_EXPORT Standard_NODISCARD
|
|
Handle(Geom_VectorWithMagnitude) Subtracted (const Handle(Geom_Vector)& Other) const;
|
|
|
|
//! Applies the transformation T to this vector.
|
|
Standard_EXPORT void Transform (const gp_Trsf& T) Standard_OVERRIDE;
|
|
|
|
//! Creates a new object which is a copy of this vector.
|
|
Standard_EXPORT Handle(Geom_Geometry) Copy() const Standard_OVERRIDE;
|
|
|
|
|
|
|
|
|
|
DEFINE_STANDARD_RTTIEXT(Geom_VectorWithMagnitude,Geom_Vector)
|
|
|
|
protected:
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif // _Geom_VectorWithMagnitude_HeaderFile
|