ForkMaster/geom
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/geom.git synced 2025-03-13 00:54:33 +05:00
Code Issues Packages Projects Releases Wiki Activity

Fix comments of Export()

Browse Source
This commit is contained in:
eap 2012-12-18 08:25:14 +00:00
parent c8eae8d292
commit 87cb5bdd59
1 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/GEOM_SWIG/geompyDC.py
View File

@ -5483,8 +5483,7 @@ class geompyDC(GEOM._objref_GEOM_Gen):
# @param theVector The translation vector. # @param theVector The translation vector.
# @param theDistance The translation distance. # @param theDistance The translation distance.
# @param theCopy Flag used to translate object itself or create a copy. # @param theCopy Flag used to translate object itself or create a copy.
# @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False or # @return New GEOM.GEOM_Object, containing the translated object.
# new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
# #
# @ref tui_translation "Example" # @ref tui_translation "Example"
def TranslateVectorDistance(self, theObject, theVector, theDistance, theCopy): def TranslateVectorDistance(self, theObject, theVector, theDistance, theCopy):
@ -5498,8 +5497,7 @@ class geompyDC(GEOM._objref_GEOM_Gen):
theCopy Flag used to translate object itself or create a copy. theCopy Flag used to translate object itself or create a copy.
Returns: Returns:
Translated theObject (GEOM.GEOM_Object) if theCopy flag is False or New GEOM.GEOM_Object, containing the translated object.
new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
""" """
# Example: see GEOM_TestAll.py # Example: see GEOM_TestAll.py
theDistance,Parameters = ParseParameters(theDistance) theDistance,Parameters = ParseParameters(theDistance)
@ -5540,9 +5538,10 @@ class geompyDC(GEOM._objref_GEOM_Gen):
# @param theObject The object to be rotated. # @param theObject The object to be rotated.
# @param theAxis Rotation axis. # @param theAxis Rotation axis.
# @param theAngle Rotation angle in radians. # @param theAngle Rotation angle in radians.
# @return Rotated @a theObject (GEOM.GEOM_Object). # @return New GEOM.GEOM_Object, containing the rotated object.
#
# @ref tui_rotation "Example" # @ref tui_rotation "Example"
def Rotate(self, theObject, theAxis, theAngle): def Rotate(self,theObject, theAxis, theAngle):
""" """
Rotate the given object around the given axis on the given angle. Rotate the given object around the given axis on the given angle.
@ -5552,7 +5551,7 @@ class geompyDC(GEOM._objref_GEOM_Gen):
theAngle Rotation angle in radians. theAngle Rotation angle in radians.
Returns: Returns:
Rotated theObject (GEOM.GEOM_Object). New GEOM.GEOM_Object, containing the rotated object.
""" """
# Example: see GEOM_TestAll.py # Example: see GEOM_TestAll.py
flag = False flag = False
@ -5562,7 +5561,7 @@ class geompyDC(GEOM._objref_GEOM_Gen):
if flag: if flag:
theAngle = theAngle*math.pi/180.0 theAngle = theAngle*math.pi/180.0
anObj = self.TrsfOp.Rotate(theObject, theAxis, theAngle) anObj = self.TrsfOp.Rotate(theObject, theAxis, theAngle)
RaiseIfFailed("Rotate", self.TrsfOp) RaiseIfFailed("RotateCopy", self.TrsfOp)
anObj.SetParameters(Parameters) anObj.SetParameters(Parameters)
return anObj return anObj
@ -5802,8 +5801,7 @@ class geompyDC(GEOM._objref_GEOM_Gen):
# @param theDistance progress of Path (0 = start location, 1 = end of path location). # @param theDistance progress of Path (0 = start location, 1 = end of path location).
# @param theCopy is to create a copy objects if true. # @param theCopy is to create a copy objects if true.
# @param theReverse 0 - for usual direction, 1 - to reverse path direction. # @param theReverse 0 - for usual direction, 1 - to reverse path direction.
# @return Displaced @a theObject (GEOM.GEOM_Object) if @a theCopy is @c False or # @return New GEOM.GEOM_Object, containing the displaced shape.
# new GEOM.GEOM_Object, containing the displaced shape if @a theCopy is @c True.
# #
# @ref tui_modify_location "Example" # @ref tui_modify_location "Example"
def PositionAlongPath(self,theObject, thePath, theDistance, theCopy, theReverse): def PositionAlongPath(self,theObject, thePath, theDistance, theCopy, theReverse):
@ -5818,8 +5816,7 @@ class geompyDC(GEOM._objref_GEOM_Gen):
theReverse 0 - for usual direction, 1 - to reverse path direction. theReverse 0 - for usual direction, 1 - to reverse path direction.
Returns: Returns:
Displaced theObject (GEOM.GEOM_Object) if theCopy is False or New GEOM.GEOM_Object, containing the displaced shape.
new GEOM.GEOM_Object, containing the displaced shape if theCopy is True.
Example of usage: Example of usage:
position = geompy.PositionAlongPath(cylinder, circle, 0.75, 1, 1) position = geompy.PositionAlongPath(cylinder, circle, 0.75, 1, 1)
@ -7523,7 +7520,8 @@ class geompyDC(GEOM._objref_GEOM_Gen):
# @param theObject Shape to be stored in the file. # @param theObject Shape to be stored in the file.
# @param theFileName Name of the file to store the given shape in. # @param theFileName Name of the file to store the given shape in.
# @param theFormatName Specify format for the shape storage. # @param theFormatName Specify format for the shape storage.
# Available formats can be obtained with InsertOp.ImportTranslators() method. # Available formats can be obtained with
# geompy.InsertOp.ExportTranslators()[0] method.
# #
# @ref swig_Import_Export "Example" # @ref swig_Import_Export "Example"
def Export(self, theObject, theFileName, theFormatName): def Export(self, theObject, theFileName, theFormatName):
@ -7534,7 +7532,8 @@ class geompyDC(GEOM._objref_GEOM_Gen):
theObject Shape to be stored in the file. theObject Shape to be stored in the file.
theFileName Name of the file to store the given shape in. theFileName Name of the file to store the given shape in.
theFormatName Specify format for the shape storage. theFormatName Specify format for the shape storage.
Available formats can be obtained with geompy.InsertOp.ImportTranslators() method. Available formats can be obtained with
geompy.InsertOp.ExportTranslators()[0] method.
""" """
# Example: see GEOM_TestOthers.py # Example: see GEOM_TestOthers.py
self.InsertOp.Export(theObject, theFileName, theFormatName) self.InsertOp.Export(theObject, theFileName, theFormatName)