diff --git a/src/AIS/AIS_InteractiveContext.hxx b/src/AIS/AIS_InteractiveContext.hxx index acbb8741ef..9f2f2647ad 100644 --- a/src/AIS/AIS_InteractiveContext.hxx +++ b/src/AIS/AIS_InteractiveContext.hxx @@ -1434,8 +1434,8 @@ protected: //! @name internal methods } //! Bind/Unbind status to object and its children - //! @param theObj [in] the object to change status - //! @param theStatus status, if NULL, unbind object + //! @param[in] theIObj the object to change status + //! @param[in] theStatus status, if NULL, unbind object Standard_EXPORT void setObjectStatus (const Handle(AIS_InteractiveObject)& theIObj, const PrsMgr_DisplayStatus theStatus, const Standard_Integer theDispyMode, diff --git a/src/AIS/AIS_Selection.hxx b/src/AIS/AIS_Selection.hxx index 1a8bfd5e8e..ce18b38ff7 100644 --- a/src/AIS/AIS_Selection.hxx +++ b/src/AIS/AIS_Selection.hxx @@ -80,10 +80,10 @@ public: const Handle(SelectMgr_EntityOwner)& Value() const { return myIterator.Value(); } //! Select or deselect owners depending on the selection scheme. - //! @param theOwners [in] elements to change selection state - //! @param theSelScheme [in] selection scheme, defines how owner is selected - //! @param theToAllowSelOverlap [in] selection flag, if true - overlapped entities are allowed - //! @param theFilter [in] context filter to skip not acceptable owners + //! @param[in] thePickedOwners elements to change selection state + //! @param[in] theSelScheme selection scheme, defines how owner is selected + //! @param[in] theToAllowSelOverlap selection flag, if true - overlapped entities are allowed + //! @param[in] theFilter context filter to skip not acceptable owners Standard_EXPORT virtual void SelectOwners (const AIS_NArray1OfEntityOwner& thePickedOwners, const AIS_SelectionScheme theSelScheme, const Standard_Boolean theToAllowSelOverlap, diff --git a/src/BRep/BRep_TFace.hxx b/src/BRep/BRep_TFace.hxx index 9d8edc974d..2654de5629 100644 --- a/src/BRep/BRep_TFace.hxx +++ b/src/BRep/BRep_TFace.hxx @@ -86,7 +86,7 @@ public: void NaturalRestriction (const Standard_Boolean theRestriction) { myNaturalRestriction = theRestriction; } //! Returns the triangulation of this face according to the mesh purpose. - //! @param theMeshPurpose [in] a mesh purpose to find appropriate triangulation (NONE by default). + //! @param[in] thePurpose a mesh purpose to find appropriate triangulation (NONE by default). //! @return an active triangulation in case of NONE purpose, //! the first triangulation appropriate for the input purpose, //! just the first triangulation if none matching other criteria and input purpose is AnyFallback diff --git a/src/BRepTools/BRepTools.hxx b/src/BRepTools/BRepTools.hxx index 51dddda991..9e50dd3fb8 100644 --- a/src/BRepTools/BRepTools.hxx +++ b/src/BRepTools/BRepTools.hxx @@ -276,7 +276,7 @@ public: //! @param theWithNormals [in] flag which specifies whether to save triangulation with (TRUE) or without (FALSE) normals; //! has no effect on triangulation-only geometry //! @param theVersion [in] the TopTools format version - //! @param theRange the range of progress indicator to fill in + //! @param theProgress the range of progress indicator to fill in Standard_EXPORT static void Write (const TopoDS_Shape& theShape, Standard_OStream& theStream, const Standard_Boolean theWithTriangles, @@ -293,7 +293,7 @@ public: //! This alias writes shape with triangulation data. //! @param theShape [in] the shape to write //! @param theFile [in] the path to file to output shape into - //! @param theRange the range of progress indicator to fill in + //! @param theProgress the range of progress indicator to fill in static Standard_Boolean Write (const TopoDS_Shape& theShape, const Standard_CString theFile, const Message_ProgressRange& theProgress = Message_ProgressRange()) @@ -310,7 +310,7 @@ public: //! @param theWithNormals [in] flag which specifies whether to save triangulation with (TRUE) or without (FALSE) normals; //! has no effect on triangulation-only geometry //! @param theVersion [in] the TopTools format version - //! @param theRange the range of progress indicator to fill in + //! @param theProgress the range of progress indicator to fill in Standard_EXPORT static Standard_Boolean Write (const TopoDS_Shape& theShape, const Standard_CString theFile, const Standard_Boolean theWithTriangles, diff --git a/src/Graphic3d/Graphic3d_CView.hxx b/src/Graphic3d/Graphic3d_CView.hxx index d10a127240..f7c0121a1e 100644 --- a/src/Graphic3d/Graphic3d_CView.hxx +++ b/src/Graphic3d/Graphic3d_CView.hxx @@ -399,7 +399,6 @@ public: //! Enables or disables IBL (Image Based Lighting) from background cubemap. //! Has no effect if PBR is not used. //! @param[in] theToEnableIBL enable or disable IBL from background cubemap - //! @param[in] theToUpdate redraw the view virtual void SetImageBasedLighting (Standard_Boolean theToEnableIBL) = 0; //! Returns environment texture set for the view. diff --git a/src/Graphic3d/Graphic3d_Camera.hxx b/src/Graphic3d/Graphic3d_Camera.hxx index 4415701d64..aeebc7cbf6 100644 --- a/src/Graphic3d/Graphic3d_Camera.hxx +++ b/src/Graphic3d/Graphic3d_Camera.hxx @@ -309,7 +309,7 @@ public: //! When switching to perspective projection from orthographic one, //! the ZNear and ZFar are reset to default values (0.001, 3000.0) //! if less than 0.0. - //! @param theProjectionType [in] the camera projection type. + //! @param[in] theProjection the camera projection type. Standard_EXPORT void SetProjectionType (const Projection theProjection); //! @return camera projection type. @@ -369,12 +369,12 @@ public: //! for orthogonal projection the view volume contains the displayed objects //! completely. For zoomed perspective view, the view volume is adjusted such //! that it contains the objects or their parts, located in front of the camera. - //! @param theScaleFactor [in] the scale factor for Z-range. + //! @param[in] theScaleFactor the scale factor for Z-range. //! The range between Z-min, Z-max projection volume planes //! evaluated by z fitting method will be scaled using this coefficient. //! Program error exception is thrown if negative or zero value is passed. - //! @param theMinMax [in] applicative min max boundaries. - //! @param theScaleFactor [in] real graphical boundaries (not accounting infinite flag). + //! @param[in] theMinMax applicative min max boundaries. + //! @param[in] theGraphicBB real graphical boundaries (not accounting infinite flag). Standard_EXPORT bool ZFitAll (const Standard_Real theScaleFactor, const Bnd_Box& theMinMax, const Bnd_Box& theGraphicBB, diff --git a/src/Graphic3d/Graphic3d_PBRMaterial.hxx b/src/Graphic3d/Graphic3d_PBRMaterial.hxx index 301b5b907b..ceba0add61 100644 --- a/src/Graphic3d/Graphic3d_PBRMaterial.hxx +++ b/src/Graphic3d/Graphic3d_PBRMaterial.hxx @@ -110,7 +110,7 @@ public: //! Generates 2D look up table of scale and bias for fresnell zero coefficient. //! It is needed for calculation reflectance part of environment lighting. //! @param [out] theLUT table storage (must be Image_Format_RGF). - //! @param [in] theIntegralSamplesCount number of importance samples in hemisphere integral calculation for every table item. + //! @param [in] theNbIntegralSamples number of importance samples in hemisphere integral calculation for every table item. Standard_EXPORT static void GenerateEnvLUT (const Handle(Image_PixMap)& theLUT, unsigned int theNbIntegralSamples = 1024); diff --git a/src/Graphic3d/Graphic3d_TransformPers.hxx b/src/Graphic3d/Graphic3d_TransformPers.hxx index 53b7592056..ed60b613d9 100644 --- a/src/Graphic3d/Graphic3d_TransformPers.hxx +++ b/src/Graphic3d/Graphic3d_TransformPers.hxx @@ -228,9 +228,10 @@ public: //! @param theViewportWidth [in] the width of viewport. //! @param theViewportHeight [in] the height of viewport. virtual Standard_Real persistentScale (const Handle(Graphic3d_Camera)& theCamera, - const Standard_Integer /*theViewportWidth*/, + const Standard_Integer theViewportWidth, const Standard_Integer theViewportHeight) const { + (void )theViewportWidth; // use total size when tiling is active const Standard_Integer aVPSizeY = theCamera->Tile().IsValid() ? theCamera->Tile().TotalSize.y() : theViewportHeight; diff --git a/src/Message/Message.hxx b/src/Message/Message.hxx index b4a461b095..1b04551d4b 100644 --- a/src/Message/Message.hxx +++ b/src/Message/Message.hxx @@ -42,7 +42,7 @@ public: //! It can be customized according to the application needs. //! //! The following syntax can be used to print messages: - //! @begincode + //! @code //! Message::DefaultMessenger()->Send ("My Warning", Message_Warning); //! Message::SendWarning ("My Warning"); // short-cut for Message_Warning //! Message::SendWarning() << "My Warning with " << theCounter << " arguments"; diff --git a/src/NCollection/NCollection_Mat3.hxx b/src/NCollection/NCollection_Mat3.hxx index 79d745cb5a..0bccf88ba2 100644 --- a/src/NCollection/NCollection_Mat3.hxx +++ b/src/NCollection/NCollection_Mat3.hxx @@ -430,8 +430,8 @@ public: } //! Compute inverted matrix. - //! @param theOutMx [out] the inverted matrix - //! @param theDet [out] determinant of matrix + //! @param[out] theInv the inverted matrix + //! @param[out] theDet determinant of matrix //! @return true if reversion success bool Inverted (NCollection_Mat3& theInv, Element_t& theDet) const { @@ -447,7 +447,7 @@ public: } //! Compute inverted matrix. - //! @param theOutMx [out] the inverted matrix + //! @param[out] theInv the inverted matrix //! @return true if reversion success bool Inverted (NCollection_Mat3& theInv) const { diff --git a/src/NCollection/NCollection_UBTree.hxx b/src/NCollection/NCollection_UBTree.hxx index 2b50ca81ba..a622117f62 100644 --- a/src/NCollection/NCollection_UBTree.hxx +++ b/src/NCollection/NCollection_UBTree.hxx @@ -150,7 +150,7 @@ public: * Forces *this node being gemmated such a way that it becomes * a branch holding the previous content of *this node at the * first child and theObj at the second child. - * @param TheNewBnd + * @param theNewBnd * new bounding box comprizing both child nodes. * @param theObj * added object. diff --git a/src/OpenGl/OpenGl_Context.hxx b/src/OpenGl/OpenGl_Context.hxx index 92e456c8e3..c7b4093305 100644 --- a/src/OpenGl/OpenGl_Context.hxx +++ b/src/OpenGl/OpenGl_Context.hxx @@ -647,7 +647,7 @@ public: //! Sets polygon hatch pattern. //! Zero-index value is a default alias for solid filling. - //! @param the type of hatch supported by base implementation of + //! @param theStyle type of hatch supported by base implementation of //! OpenGl_LineAttributes (Aspect_HatchStyle) or the type supported by custom //! implementation derived from OpenGl_LineAttributes class. //! @return old type of hatch. @@ -774,9 +774,9 @@ public: //! @name methods to alter or retrieve current state //! - TRUE when writing into offscreen FBO (always expected to be in sRGB or RGBF formats). //! - TRUE when writing into sRGB-ready window buffer (might require choosing proper pixel format on window creation). //! - FALSE if sRGB rendering is not supported or sRGB-not-ready window buffer is used for drawing. - //! @param theIsFbo [in] flag indicating writing into offscreen FBO (always expected sRGB-ready when sRGB FBO is supported) - //! or into window buffer (FALSE, sRGB-readiness might vary). - //! @param theIsSRgb [in] flag indicating off-screen FBO is sRGB-ready + //! @param[in] theIsFbo flag indicating writing into offscreen FBO (always expected sRGB-ready when sRGB FBO is supported) + //! or into window buffer (FALSE, sRGB-readiness might vary). + //! @param[in] theIsFboSRgb flag indicating off-screen FBO is sRGB-ready Standard_EXPORT void SetFrameBufferSRGB (bool theIsFbo, bool theIsFboSRgb = true); //! Return cached flag indicating writing into color buffer is enabled or disabled (glColorMask). diff --git a/src/OpenGl/OpenGl_GraphicDriver.hxx b/src/OpenGl/OpenGl_GraphicDriver.hxx index 3cdbe91fe4..64e0518e61 100644 --- a/src/OpenGl/OpenGl_GraphicDriver.hxx +++ b/src/OpenGl/OpenGl_GraphicDriver.hxx @@ -106,17 +106,17 @@ public: public: //! Adds a layer to all views. - //! @param theLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers). - //! @param theSettings [in] new layer settings - //! @param theLayerAfter [in] id of layer to append new layer before + //! @param[in] theNewLayerId id of new layer, should be > 0 (negative values are reserved for default layers). + //! @param[in] theSettings new layer settings + //! @param[in] theLayerAfter id of layer to append new layer before Standard_EXPORT virtual void InsertLayerBefore (const Graphic3d_ZLayerId theNewLayerId, const Graphic3d_ZLayerSettings& theSettings, const Graphic3d_ZLayerId theLayerAfter) Standard_OVERRIDE; //! Adds a layer to all views. - //! @param theLayerId [in] id of created layer - //! @param theSettings [in] new layer settings - //! @param theLayerBefore [in] id of layer to append new layer after + //! @param[in] theNewLayerId id of created layer + //! @param[in] theSettings new layer settings + //! @param[in] theLayerBefore id of layer to append new layer after Standard_EXPORT virtual void InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId, const Graphic3d_ZLayerSettings& theSettings, const Graphic3d_ZLayerId theLayerBefore) Standard_OVERRIDE; diff --git a/src/Standard/Standard_Dump.hxx b/src/Standard/Standard_Dump.hxx index eec5c9dc92..c8f2d6facc 100644 --- a/src/Standard/Standard_Dump.hxx +++ b/src/Standard/Standard_Dump.hxx @@ -383,33 +383,33 @@ public: Standard_EXPORT static void DumpRealValues (Standard_OStream& theOStream, int theCount, ...); //! Check whether the parameter name is equal to the name in the stream at position - //! @param theSStream [in] stream with values - //! @param theName [in] stream key value - //! @param theStreamPos [out] current position in the stream + //! @param[in] theStreamStr stream with values + //! @param[in] theName stream key value + //! @param[out] theStreamPos current position in the stream Standard_EXPORT static Standard_Boolean ProcessStreamName (const TCollection_AsciiString& theStreamStr, const TCollection_AsciiString& theName, Standard_Integer& theStreamPos); //! Check whether the field name is equal to the name in the stream at position - //! @param theSStream [in] stream with values - //! @param theName [in] stream key field value - //! @param theStreamPos [out] current position in the stream + //! @param[in] theStreamStr stream with values + //! @param[in] theName stream key field value + //! @param[out] theStreamPos current position in the stream Standard_EXPORT static Standard_Boolean ProcessFieldName (const TCollection_AsciiString& theStreamStr, const TCollection_AsciiString& theName, Standard_Integer& theStreamPos); //! Unite values in one value using template: value_1, value_2, ..., value_n - //! @param theSStream [in] stream with values - //! @param theStreamPos [out] current position in the stream - //! @param theCount [in] number of values + //! @param[in] theStreamStr stream with values + //! @param[out] theStreamPos current position in the stream + //! @param[in] theCount number of values Standard_EXPORT static Standard_Boolean InitRealValues (const TCollection_AsciiString& theStreamStr, Standard_Integer& theStreamPos, int theCount, ...); //! Returns real value - //! @param theSStream [in] stream with values - //! @param theStreamPos [out] current position in the stream - //! @param theValue [out] stream value + //! @param[in] theStreamStr stream with values + //! @param[out] theStreamPos current position in the stream + //! @param[out] theValue stream value Standard_EXPORT static Standard_Boolean InitValue (const TCollection_AsciiString& theStreamStr, Standard_Integer& theStreamPos, TCollection_AsciiString& theValue); diff --git a/src/StdPrs/StdPrs_ToolTriangulatedShape.hxx b/src/StdPrs/StdPrs_ToolTriangulatedShape.hxx index 44f65328a0..b7ee68550d 100644 --- a/src/StdPrs/StdPrs_ToolTriangulatedShape.hxx +++ b/src/StdPrs/StdPrs_ToolTriangulatedShape.hxx @@ -59,9 +59,9 @@ public: Poly_Connect& thePolyConnect); //! Evaluate normals for a triangle of a face. - //! @param theFace [in] the face. - //! @param thePolyConnect [in] the definition of a face triangulation. - //! @param theNormal [out] the array of normals for each triangle. + //! @param[in] theFace the face. + //! @param[in] thePolyConnect the definition of a face triangulation. + //! @param[out] theNormals the array of normals for each triangle. Standard_EXPORT static void Normal (const TopoDS_Face& theFace, Poly_Connect& thePolyConnect, TColgp_Array1OfDir& theNormals); diff --git a/src/TCollection/TCollection_ExtendedString.hxx b/src/TCollection/TCollection_ExtendedString.hxx index 899eecd7f9..be5c3f97b3 100644 --- a/src/TCollection/TCollection_ExtendedString.hxx +++ b/src/TCollection/TCollection_ExtendedString.hxx @@ -333,7 +333,7 @@ friend Standard_EXPORT Standard_OStream& operator << (Standard_OStream& astream, //! Returns a hashed value for the extended string within the range 1 .. theUpper. //! Note: if string is ASCII, the computed value is the same as the value computed with the HashCode function on a //! TCollection_AsciiString string composed with equivalent ASCII characters. - //! @param theExtendedString the extended string which hash code is to be computed + //! @param theString the extended string which hash code is to be computed //! @param theUpperBound the upper bound of the range a computing hash code must be within //! @return a computed hash code, in the range [1, theUpperBound] static Standard_Integer HashCode (const TCollection_ExtendedString& theString, diff --git a/src/TDataStd/TDataStd_NamedData.hxx b/src/TDataStd/TDataStd_NamedData.hxx index 1072256a57..d3b58d5c95 100644 --- a/src/TDataStd/TDataStd_NamedData.hxx +++ b/src/TDataStd/TDataStd_NamedData.hxx @@ -177,8 +177,8 @@ public: Standard_EXPORT const Handle(TColStd_HArray1OfReal)& GetArrayOfReals (const TCollection_ExtendedString& theName); //! Defines a named array of real values. - //! @param theName [in] key - //! @param theArrayOfIntegers [in] new value, overrides existing (passed array will be copied by value!) + //! @param[in] theName key + //! @param[in] theArrayOfReals new value, overrides existing (passed array will be copied by value!) void SetArrayOfReals (const TCollection_ExtendedString& theName, const Handle(TColStd_HArray1OfReal)& theArrayOfReals) { diff --git a/src/gp/gp_XY.hxx b/src/gp/gp_XY.hxx index 2310780e02..a86853310c 100644 --- a/src/gp/gp_XY.hxx +++ b/src/gp/gp_XY.hxx @@ -115,6 +115,7 @@ public: //! @code //! .X() = .X() + theOther.X() //! .Y() = .Y() + theOther.Y() + //! @endcode inline void Add (const gp_XY& theOther) { x += theOther.x; @@ -183,6 +184,7 @@ public: //! @code //! .X() = .X() * theScalar; //! .Y() = .Y() * theScalar; + //! @endcode void Multiply (const Standard_Real theScalar) { x *= theScalar; @@ -194,6 +196,7 @@ public: //! @code //! .X() = .X() * theOther.X(); //! .Y() = .Y() * theOther.Y(); + //! @endcode void Multiply (const gp_XY& theOther) { x *= theOther.x; @@ -210,16 +213,17 @@ public: //! @code //! New.X() = .X() * theScalar; //! New.Y() = .Y() * theScalar; + //! @endcode Standard_NODISCARD gp_XY Multiplied (const Standard_Real theScalar) const { return gp_XY (x * theScalar, y * theScalar); } Standard_NODISCARD gp_XY operator* (const Standard_Real theScalar) const { return Multiplied (theScalar); } //! @code //! new.X() = .X() * theOther.X(); //! new.Y() = .Y() * theOther.Y(); + //! @endcode Standard_NODISCARD gp_XY Multiplied (const gp_XY& theOther) const { return gp_XY (x * theOther.X(), y * theOther.Y()); } //! New = theMatrix * - //! @endcode Standard_NODISCARD gp_XY Multiplied (const gp_Mat2d& theMatrix) const { return gp_XY (theMatrix.Value (1, 1) * x + theMatrix.Value (1, 2) * y, @@ -258,6 +262,7 @@ public: //! @code //! New.X() = -.X() //! New.Y() = -.Y() + //! @endcode Standard_NODISCARD gp_XY Reversed() const { gp_XY aCoord2D = *this; @@ -271,6 +276,7 @@ public: //! assigns the result to this number pair: //! @code //! theA1 * theXY1 + theA2 * theXY2 + //! @endcode inline void SetLinearForm (const Standard_Real theA1, const gp_XY& theXY1, const Standard_Real theA2, const gp_XY& theXY2) { @@ -282,6 +288,7 @@ public: //! assigns the result to this number pair: //! @code //! theA1 * theXY1 + theA2 * theXY2 + theXY3 + //! @endcode inline void SetLinearForm (const Standard_Real theA1, const gp_XY& theXY1, const Standard_Real theA2, const gp_XY& theXY2, const gp_XY& theXY3) @@ -294,6 +301,7 @@ public: //! assigns the result to this number pair: //! @code //! theA1 * theXY1 + theXY2 + //! @endcode inline void SetLinearForm (const Standard_Real theA1, const gp_XY& theXY1, const gp_XY& theXY2) { @@ -305,6 +313,7 @@ public: //! assigns the result to this number pair: //! @code //! theXY1 + theXY2 + //! @endcode inline void SetLinearForm (const gp_XY& theXY1, const gp_XY& theXY2) { @@ -315,6 +324,7 @@ public: //! @code //! .X() = .X() - theOther.X() //! .Y() = .Y() - theOther.Y() + //! @endcode inline void Subtract (const gp_XY& theOther) { x -= theOther.x; diff --git a/src/gp/gp_XYZ.hxx b/src/gp/gp_XYZ.hxx index fa944ab788..ed247ebc76 100644 --- a/src/gp/gp_XYZ.hxx +++ b/src/gp/gp_XYZ.hxx @@ -139,6 +139,7 @@ public: //! .X() = .X() + theOther.X() //! .Y() = .Y() + theOther.Y() //! .Z() = .Z() + theOther.Z() + //! @endcode void Add (const gp_XYZ& theOther) { x += theOther.x; @@ -164,6 +165,7 @@ public: //! .X() = .Y() * theOther.Z() - .Z() * theOther.Y() //! .Y() = .Z() * theOther.X() - .X() * theOther.Z() //! .Z() = .X() * theOther.Y() - .Y() * theOther.X() + //! @endcode void Cross (const gp_XYZ& theOther); void operator^= (const gp_XYZ& theOther) { Cross (theOther); } @@ -230,6 +232,7 @@ public: //! .X() = .X() * theScalar; //! .Y() = .Y() * theScalar; //! .Z() = .Z() * theScalar; + //! @endcode void Multiply (const Standard_Real theScalar) { x *= theScalar; @@ -243,6 +246,7 @@ public: //! .X() = .X() * theOther.X(); //! .Y() = .Y() * theOther.Y(); //! .Z() = .Z() * theOther.Z(); + //! @endcode void Multiply (const gp_XYZ& theOther) { x *= theOther.x; @@ -261,6 +265,7 @@ public: //! New.X() = .X() * theScalar; //! New.Y() = .Y() * theScalar; //! New.Z() = .Z() * theScalar; + //! @endcode Standard_NODISCARD gp_XYZ Multiplied (const Standard_Real theScalar) const { return gp_XYZ (x * theScalar, y * theScalar, z * theScalar); } Standard_NODISCARD gp_XYZ operator* (const Standard_Real theScalar) const { return Multiplied (theScalar); } @@ -269,10 +274,10 @@ public: //! new.X() = .X() * theOther.X(); //! new.Y() = .Y() * theOther.Y(); //! new.Z() = .Z() * theOther.Z(); + //! @endcode Standard_NODISCARD gp_XYZ Multiplied (const gp_XYZ& theOther) const { return gp_XYZ (x * theOther.x, y * theOther.y, z * theOther.z); } //! New = theMatrix * - //! @endcode Standard_NODISCARD gp_XYZ Multiplied (const gp_Mat& theMatrix) const { return gp_XYZ (theMatrix.Value (1, 1) * x + theMatrix.Value (1, 2) * y + theMatrix.Value (1, 3) * z, @@ -307,6 +312,7 @@ public: //! .X() = -.X() //! .Y() = -.Y() //! .Z() = -.Z() + //! @endcode void Reverse() { x = -x; @@ -318,12 +324,14 @@ public: //! New.X() = -.X() //! New.Y() = -.Y() //! New.Z() = -.Z() + //! @endcode Standard_NODISCARD gp_XYZ Reversed() const { return gp_XYZ (-x, -y, -z); } //! @code //! .X() = .X() - theOther.X() //! .Y() = .Y() - theOther.Y() //! .Z() = .Z() - theOther.Z() + //! @endcode void Subtract (const gp_XYZ& theOther) { x -= theOther.x; @@ -337,6 +345,7 @@ public: //! new.X() = .X() - theOther.X() //! new.Y() = .Y() - theOther.Y() //! new.Z() = .Z() - theOther.Z() + //! @endcode Standard_NODISCARD gp_XYZ Subtracted (const gp_XYZ& theOther) const { return gp_XYZ (x - theOther.x, y - theOther.y, z - theOther.z); } Standard_NODISCARD gp_XYZ operator- (const gp_XYZ& theOther) const { return Subtracted (theOther); } @@ -344,6 +353,7 @@ public: //! is set to the following linear form : //! @code //! theA1 * theXYZ1 + theA2 * theXYZ2 + theA3 * theXYZ3 + theXYZ4 + //! @endcode void SetLinearForm (const Standard_Real theA1, const gp_XYZ& theXYZ1, const Standard_Real theA2, const gp_XYZ& theXYZ2, const Standard_Real theA3, const gp_XYZ& theXYZ3, @@ -357,6 +367,7 @@ public: //! is set to the following linear form : //! @code //! theA1 * theXYZ1 + theA2 * theXYZ2 + theA3 * theXYZ3 + //! @endcode void SetLinearForm (const Standard_Real theA1, const gp_XYZ& theXYZ1, const Standard_Real theA2, const gp_XYZ& theXYZ2, const Standard_Real theA3, const gp_XYZ& theXYZ3) @@ -369,6 +380,7 @@ public: //! is set to the following linear form : //! @code //! theA1 * theXYZ1 + theA2 * theXYZ2 + theXYZ3 + //! @endcode void SetLinearForm (const Standard_Real theA1, const gp_XYZ& theXYZ1, const Standard_Real theA2, const gp_XYZ& theXYZ2, const gp_XYZ& theXYZ3) @@ -381,6 +393,7 @@ public: //! is set to the following linear form : //! @code //! theA1 * theXYZ1 + theA2 * theXYZ2 + //! @endcode void SetLinearForm (const Standard_Real theA1, const gp_XYZ& theXYZ1, const Standard_Real theA2, const gp_XYZ& theXYZ2) { @@ -392,6 +405,7 @@ public: //! is set to the following linear form : //! @code //! theA1 * theXYZ1 + theXYZ2 + //! @endcode void SetLinearForm (const Standard_Real theA1, const gp_XYZ& theXYZ1, const gp_XYZ& theXYZ2) { @@ -403,6 +417,7 @@ public: //! is set to the following linear form : //! @code //! theXYZ1 + theXYZ2 + //! @endcode void SetLinearForm (const gp_XYZ& theXYZ1, const gp_XYZ& theXYZ2) { x = theXYZ1.x + theXYZ2.x;