Hide Table of Contents
GetEquationParameters Method (ISketchSpline)

Obsolete. Superseded by ISketchSpline::GetEquationParameters2.

.NET Syntax

Visual Basic (Declaration) 
Function GetEquationParameters( _
   ByRef YExpression As String, _
   ByRef RangeStart As Double, _
   ByRef RangeEnd As Double, _
   ByRef IsAngleRange As Boolean, _
   ByRef RotationAngle As Double, _
   ByRef XOffset As Double, _
   ByRef YOffset As Double, _
   ByRef LockStart As Boolean, _
   ByRef LockEnd As Boolean _
) As Boolean
Visual Basic (Usage) 
Dim instance As ISketchSpline
Dim YExpression As String
Dim RangeStart As Double
Dim RangeEnd As Double
Dim IsAngleRange As Boolean
Dim RotationAngle As Double
Dim XOffset As Double
Dim YOffset As Double
Dim LockStart As Boolean
Dim LockEnd As Boolean
Dim value As Boolean
 
value = instance.GetEquationParameters(YExpression, RangeStart, RangeEnd, IsAngleRange, RotationAngle, XOffset, YOffset, LockStart, LockEnd)
C# 
bool GetEquationParameters( 
   out string YExpression,
   out double RangeStart,
   out double RangeEnd,
   out bool IsAngleRange,
   out double RotationAngle,
   out double XOffset,
   out double YOffset,
   out bool LockStart,
   out bool LockEnd
)
C++/CLI 
bool GetEquationParameters( 
&   [Out] String^ YExpression,
&   [Out] double RangeStart,
&   [Out] double RangeEnd,
&   [Out] bool IsAngleRange,
&   [Out] double RotationAngle,
&   [Out] double XOffset,
&   [Out] double YOffset,
&   [Out] bool LockStart,
&   [Out] bool LockEnd
) 

Parameters

YExpression
Equation for y (see Remarks)
RangeStart
Start value of x (see Remarks)
RangeEnd
End value of x (see Remarks)
IsAngleRange
True if the range and x value represent an angle (in radians), false if not
RotationAngle
Rotation angle (in radians) for the curve
XOffset
Offset in x for f(x), where x = 0 (see Remarks)
YOffset
Offset in y for f(x), where x = 0 (see Remarks)
LockStart
True to lock the start point (RangeStart) of the curve, false to not
LockEnd
True to lock the end point (RangeEnd) of the curve, false to not

Return Value

True if the equation-driven curve's parameters are returned, false if not

Example

Remarks

YExpression:

  Any function that you can define as a 2D function in the following form:

     y-in-the-sketch = f(x-in-the-sketch)

  will appear as a curve in the sketch. For example:

     y = sin(x)

 

RangeStart and RangeEnd

You cannot specify string values for RangeStart and RangeEnd; you must specify double values.

 

XOffset:

  In the equation:

    y = sin(x) [x=0 to 2Pi]

  the start point (0,0) is moved by XOffset in the x direction. 

YOffset:

In the equation:

    y = sin(x) [x=0 to 2Pi]

  the start point (0,0) is moved by YOffset in the y direction. 

 

See Also

Availability

SolidWorks 2009 FCS, Revision Number 17.0


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   GetEquationParameters Method (ISketchSpline)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2012 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.