Effects.CurveDesigner.GetPoints method |
|
Remarks
Retrieves positions of Bézier curve control points (right and left) inside the curve designer. Control points can be modified programmatically through the Effects.CurveDesigner.SetPoints method or through the mouse by dragging provided "handles".
For details about using the Curve Designer refer to the How to create custom volume curves tutorial.
For further details about defining a volume automation procedure refer to the How to define a volume automation procedure section.
Syntax
[Visual Basic] Public Function GetPoints ( nDesignerUniqueId as Int32, ByRef nLeftX as Int16, ByRef nLeftY as Int16, ByRef nRightX as Int16, ByRef nRightY as Int16 ) as enumErrorCodes |
[C#] public enumErrorCodes GetPoints ( Int32 nDesignerUniqueId, ref Int16 nLeftX, ref Int16 nLeftY, ref Int16 nRightX, ref Int16 nRightY ); |
[C++] public: enumErrorCodes GetPoints ( Int32 nDesignerUniqueId, Int16 __gc *nLeftX, Int16 __gc *nLeftY, Int16 __gc *nRightX, Int16 __gc *nRightY ); |
Parameter |
Description |
|
|
nDesignerUniqueId |
Unique identifier of the curve designer returned by a previous call to the Effects.CurveDesigner.Create method |
nLeftX |
Reference that, on return from the method call, will contain the horizontal position, expressed in percentage of the designer's area, of the left control point |
nLeftY |
Reference that, on return from the method call, will contain the vertical position, expressed in percentage of the designer's area, of the left control point |
nRightX |
Reference that, on return from the method call, will contain the horizontal position, expressed in percentage of the designer's area, of the right control point |
nRightY |
Reference that, on return from the method call, will contain the vertical position, expressed in percentage of the designer's area, of the right control point |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful. |