All Frameworks Class Hierarchy This Framework Previous Next Indexes
GSMInterfaces Interface CATIGSMSpline
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIGSMSpline
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMSpline
Spline feature.
Role:Allows to access data of the spline feature.
- See also:
- CATIGSMFactory.CreateSplinePoints
Method Index
- o
Add(CATISpecObject_var)
- Adds a point to the spline.
- o
AddCurvatureRadiusDirection(CATIGSMDirection_var&,int)
- Adds Curvature Radius Direction (norme is not use) for each point of the spline.
- o
AddTangentDirection(CATIGSMDirection_var&,int)
- Adds tangent Direction (norme is not use) for each point of the spline .
- o
GetClosure(int&)
- Gets whether the curve is closed.
- o
GetConstraintType(CATIGSMConstraintType&,int)
- Gets the type of a constraint at a given position of the spline.
- o
GetCurvatureRadiusDirection(CATIGSMDirection_var&,int)
- Gets Curvature Radius Direction (norme is not use) for each point of the spline.
- o
GetCurvatureRadiusValue(CATICkeParm_var&,int)
- Gets Curvature Radius Value for each point of the spline.
- o
GetCurveConstraint(CATISpecObject_var&,int)
- Gets curve specifiying a tangent or curvature constraint at a given position of the spline.
- o
GetCurveConstraintType(CATIGSMConstraintFromCurveType&,int)
- Gets the type of a constraint specified by a curve at a given position of the spline.
- o
GetDirectionInversion(int&,int)
- Gets the orientation of the tangent direction .
- o
GetPointAtPosition(CATISpecObject_var&,int)
- Gets the point which is at the given position.
- o
GetPosition(CATISpecObject_var,int&)
- Gets the position of an element in the list.
- o
GetSemiClosure(CATISpecObject_var&)
- Gets the semi-closure point of the closed spline.
- o
GetSize(int&)
- Gets the size of the list (number of points).
- o
GetSplineType(CATIGSMSplineType&)
- Gets the spline type.
- o
GetSupport(CATISpecObject_var&)
- Gets the support surface.
- o
GetTangentDirection(CATIGSMDirection_var&,int)
- Gets tangent Direction (norme is not use) for each point of the spline.
- o
GetTangentNorm(CATICkeParm_var&,int)
- Gets the Tension (Tangent Norme) for each point of the spline.
- o
InsertAfterPosition(CATISpecObject_var,int)
- Inserts a point after another at a given position.
- o
InsertBeforePosition(CATISpecObject_var,int)
- Inserts a point before another at a given position.
- o
InvertDirection(int)
- Inverts the orientation of the tangent direction .
- o
RemoveAll()
- Removes all elements in the list of points.
- o
RemoveCurvatureRadiusDirection(int)
- Removes Curvature Radius Direction (norme is not use) for each point of the spline.
- o
RemoveCurvatureRadiusValue(int)
- Removes Curvature Radius Value for each point of the spline.
- o
RemoveCurveConstraint(int)
- Removes curve specifiying a tangent or curvature constraint at a given position of the spline.
- o
RemovePointAtPosition(int)
- Removes the points at the given position.
- o
RemoveSupport()
- Removes the support surface.
- o
RemoveTangentDirection(int)
- Removes tangent Direction (norme is not use) for each point of the spline.
- o
RemoveTangentNorm(int)
- Removes the Tension (Tangent Norme) for each point of the spline.
- o
ReplacePointAtPosition(CATISpecObject_var&,int)
- Replaces a point in the list at the given position.
- o
SetClosure(int)
- Sets whether the curve is closed.
- o
SetCurvatureRadiusValue(CATICkeParm_var&,int)
- Sets Curvature Radius Value for each point of the spline.
- o
SetCurveConstraint(CATISpecObject_var,int)
- Sets curve specifying a tangent or curvature constraint at a given position of the spline.
- o
SetCurveConstraintType(CATIGSMConstraintFromCurveType,int)
- Sets the type of a constraint specified by a curve at a given position of the spline.
- o
SetSemiClosure(CATISpecObject_var)
- Sets the semi-closure point of the closed spline.
- o
SetSplineType(CATIGSMSplineType)
- Sets the spline type.
- o
SetSupport(CATISpecObject_var)
- Sets the support surface.
- o
SetTangentNorm(CATICkeParm_var&,int)
- Sets the Tension (Tangent Norme) for each point of the spline.
Enumerated Type Index
- o
CATIGSMConstraintFromCurveType
- Different kinds of constraint specified by a curve.
- o
CATIGSMConstraintType
- Different kinds of constraint specified at a given position of the spline.
- o
CATIGSMSplineType
- Different kinds of spline.
Methods
o Add
-
Adds a point to the spline.
The point is added at the end of the list.
- Parameters:
-
- iPoint
- Point
o AddCurvatureRadiusDirection
public virtual HRESULT AddCurvatureRadiusDirection( | const CATIGSMDirection_var& | iCrDir, |
| int | iPos) = 0 |
-
Adds Curvature Radius Direction (norme is not use) for each point of the spline.
A tangent direction AND Norm are Necessary
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- iCrDir
- Curvature radius
- iPos
- Position of point in spline
- See also:
- CATIGSMDirection
o AddTangentDirection
public virtual HRESULT AddTangentDirection( | const CATIGSMDirection_var& | iTgtDir, |
| int | iPos) = 0 |
-
Adds tangent Direction (norme is not use) for each point of the spline .
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- iTgtDir
- Tangent direction
- iPos
- Position of point in spline
- See also:
- CATIGSMDirection
o GetClosure
public virtual HRESULT GetClosure( | int& | oClosed)= 0 |
-
Gets whether the curve is closed.
- Parameters:
-
- oClosed
- Closing flag
- 1
- for a closed curve
- 0
- for an open curve
o GetConstraintType
public virtual HRESULT GetConstraintType( | CATIGSMConstraintType& | oType, |
| int | iPos) = 0 |
-
Gets the type of a constraint at a given position of the spline.
- Parameters:
-
- oType
- Constraint type (explicit or specified from curve)
- iPos
- Position of point in spline
o GetCurvatureRadiusDirection
public virtual HRESULT GetCurvatureRadiusDirection( | CATIGSMDirection_var& | oCrDir, |
| int | iPos) = 0 |
-
Gets Curvature Radius Direction (norme is not use) for each point of the spline.
A tangent direction AND Norm are Necessary
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- oCrDir
- Curvature radius
- iPos
- Position of point in spline
- See also:
- CATIGSMDirection
o GetCurvatureRadiusValue
public virtual HRESULT GetCurvatureRadiusValue( | CATICkeParm_var& | oCrVal, |
| int | iPos) = 0 |
-
Gets Curvature Radius Value for each point of the spline.
A tangent direction AND Norm are Necessary
A Curvature Radius Direction is Necessary
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- oCrVal
- Curvature value
- iPos
- Position of point in spline
- See also:
- CATICkeParm
o GetCurveConstraint
public virtual HRESULT GetCurveConstraint( | CATISpecObject_var& | oCrv, |
| int | iPos) = 0 |
-
Gets curve specifiying a tangent or curvature constraint at a given position of the spline.
- Parameters:
-
- oCrv
- Curve
- iPos
- Position of point in spline
o GetCurveConstraintType
public virtual HRESULT GetCurveConstraintType( | CATIGSMConstraintFromCurveType& | oType, |
| int | iPos) = 0 |
-
Gets the type of a constraint specified by a curve at a given position of the spline.
- Parameters:
-
- oType
- Constraint from curve type
- iPos
- Position of point in spline
o GetDirectionInversion
public virtual HRESULT GetDirectionInversion( | int& | oInvertFlag, |
| int | iPos) = 0 |
-
Gets the orientation of the tangent direction .
Value iPos
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- oInvertFlag
- invert flag
= 1 No Inversion
= -1 Invert
- iPos
- Position of point in spline
o GetPointAtPosition
public virtual HRESULT GetPointAtPosition( | CATISpecObject_var& | oPoint, |
| int | iPos) = 0 |
-
Gets the point which is at the given position.
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- oPoint
- Point
- iPos
- Insert position
o GetPosition
-
Gets the position of an element in the list.
- Parameters:
-
- iPoint
- Point
- oPos
- position in spline
o GetSemiClosure
public virtual HRESULT GetSemiClosure( | CATISpecObject_var& | oPoint) = 0 |
-
Gets the semi-closure point of the closed spline.
- Parameters:
-
- oPoint
- Semi-closure point
o GetSize
public virtual HRESULT GetSize( | int& | oSize) = 0 |
-
Gets the size of the list (number of points).
- Parameters:
-
- oSize
- number of points
o GetSplineType
public virtual HRESULT GetSplineType( | CATIGSMSplineType& | oType) = 0 |
-
Gets the spline type.
- Parameters:
-
- oType
- Spline Type
o GetSupport
public virtual HRESULT GetSupport( | CATISpecObject_var& | oSupport) = 0 |
-
Gets the support surface.
- Parameters:
-
- oSupport
- Supporting surface for spline (if exist)
o GetTangentDirection
public virtual HRESULT GetTangentDirection( | CATIGSMDirection_var& | oTgtDir, |
| int | iPos) = 0 |
-
Gets tangent Direction (norme is not use) for each point of the spline.
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- iTgtDir
- Tangent direction
- iPos
- Position of point in spline
- See also:
- CATIGSMDirection
o GetTangentNorm
public virtual HRESULT GetTangentNorm( | CATICkeParm_var& | oTgtNm, |
| int | iPos) = 0 |
-
Gets the Tension (Tangent Norme) for each point of the spline.
A tangent direction is necessary
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- oTgtNm
- Tension
- iPos
- Position of point in spline
- See also:
- CATICkeParm
o InsertAfterPosition
-
Inserts a point after another at a given position.
First Position is 1
- InsertAfterPosition(MyPoint,0) Add at the begining of the spline
- InsertAfterPosition(MyPoint,SplineSize) Add at the end of the spline
- Parameters:
-
- iPoint
- Point
- iPos
- Insert after position
o InsertBeforePosition
-
Inserts a point before another at a given position.
- Parameters:
-
- iPoint
- Point
- iPos
- Insert before position
o InvertDirection
public virtual HRESULT InvertDirection( | int | iPos) = 0 |
-
Inverts the orientation of the tangent direction .
- Parameters:
-
- iPos
- First Position is 1
Position 0 return E_FAIL
- Returns:
- S_OK if OK, E_FAIL if fail
o RemoveAll
public virtual HRESULT RemoveAll( | )= 0 |
-
Removes all elements in the list of points.
o RemoveCurvatureRadiusDirection
public virtual HRESULT RemoveCurvatureRadiusDirection( | int | iPos) = 0 |
-
Removes Curvature Radius Direction (norme is not use) for each point of the spline.
A tangent direction AND Radius are Necessary
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- iPos
- Position of point in spline
o RemoveCurvatureRadiusValue
public virtual HRESULT RemoveCurvatureRadiusValue( | int | iPos) = 0 |
-
Removes Curvature Radius Value for each point of the spline.
A tangent direction AND Norm is Necessary
A Curvature Radius Direction is Necessary
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- iPos
- Position of point in spline
o RemoveCurveConstraint
public virtual HRESULT RemoveCurveConstraint( | int | iPos) = 0 |
-
Removes curve specifiying a tangent or curvature constraint at a given position of the spline.
- Parameters:
-
- iPos
- Position of point in spline
o RemovePointAtPosition
public virtual HRESULT RemovePointAtPosition( | int | iPos) = 0 |
-
Removes the points at the given position.
- Parameters:
-
- iPos
- Insert position
o RemoveSupport
public virtual HRESULT RemoveSupport( | )= 0 |
-
Removes the support surface.
o RemoveTangentDirection
public virtual HRESULT RemoveTangentDirection( | int | iPos) = 0 |
-
Removes tangent Direction (norme is not use) for each point of the spline.
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- iPos
- Position of point in spline
o RemoveTangentNorm
public virtual HRESULT RemoveTangentNorm( | int | iPos) = 0 |
-
Removes the Tension (Tangent Norme) for each point of the spline.
A tangent direction is necessary
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- iPos
- Position of point in spline
o ReplacePointAtPosition
public virtual HRESULT ReplacePointAtPosition( | CATISpecObject_var& | oPoint, |
| int | iPos) = 0 |
-
Replaces a point in the list at the given position.
- Parameters:
-
- oPoint
- Point
- iPos
- Replace position
o SetClosure
public virtual HRESULT SetClosure( | int | iClosed)= 0 |
-
Sets whether the curve is closed.
- Parameters:
-
- iClosed
- Closing flag
- 1
- for a closed curve
- 0
- for an open curve
o SetCurvatureRadiusValue
public virtual HRESULT SetCurvatureRadiusValue( | const CATICkeParm_var& | iCrVal, |
| int | iPos) = 0 |
-
Sets Curvature Radius Value for each point of the spline.
A tangent direction AND Norm are Necessary
A Curvature Radius Direction is Necessary
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- iCrVal
- Curvature value
- iPos
- Position of point in spline
- See also:
- CATICkeParm
o SetCurveConstraint
-
Sets curve specifying a tangent or curvature constraint at a given position of the spline.
- Parameters:
-
- iCrv
- Curve
- iPos
- Position of point in spline
o SetCurveConstraintType
public virtual HRESULT SetCurveConstraintType( | const CATIGSMConstraintFromCurveType | iType, |
| int | iPos) = 0 |
-
Sets the type of a constraint specified by a curve at a given position of the spline.
- Parameters:
-
- iType
- Constraint from curve Type
- iPos
- Position of point in spline
o SetSemiClosure
-
Sets the semi-closure point of the closed spline.
- Parameters:
-
- iPoint
- Semi-closure point
o SetSplineType
public virtual HRESULT SetSplineType( | const CATIGSMSplineType | iType) = 0 |
-
Sets the spline type.
- Parameters:
-
- iType
- Set spline Type
o SetSupport
-
Sets the support surface.
With support we recommand to have your "tangent direction"
tangent to this support
- Parameters:
-
- iSupport
- Set Supporting surface for spline (if exist)
o SetTangentNorm
public virtual HRESULT SetTangentNorm( | const CATICkeParm_var& | iTgtNm, |
| int | iPos) = 0 |
-
Sets the Tension (Tangent Norme) for each point of the spline.
A tangent direction is necessary
First Position is 1
Position 0 return E_FAIL
- Parameters:
-
- iTgtNm
- Tension
- iPos
- Position of point in spline
- See also:
- CATICkeParm
Enumerated Types
o CATIGSMConstraintFromCurveType
-
enum CATIGSMConstraintFromCurveType {
Tangency,
Curvature
}
Different kinds of constraint specified by a curve.
- Parameters:
-
- Tangency
- Tangency continuity
- Curvature
- Curvature continuity
o CATIGSMConstraintType
-
enum CATIGSMConstraintType {
GSMSpline_None,
GSMSpline_Explicit,
GSMSpline_FromCurve
}
Different kinds of constraint specified at a given position of the spline.
- Parameters:
-
- None
- No constraint is specified
- Explicit
- Constraint specified by a tangent direction, a tangent norm (tension parameter), a curvature direction,
a curvature radius.
- From
- curve Constraint (tangency or curvature) specified by a curve and a tension parameter.
o CATIGSMSplineType
-
enum CATIGSMSplineType {
Cubic,
WilsonFowler
}
Different kinds of spline.
- Parameters:
-
- Cubic
- Cubic spline
- WilsonFowler
- WilsonFowler spline
This object is included in the file: CATIGSMSpline.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces