Description

Creates a displacement vector.

Syntax

[Visual Basic .NET]
Public Function CreateDisplacementVector( _ ByVal VectorName As String, _ ByVal OriginPoint As IAgCrdnPoint, _ ByVal DestPoint As IAgCrdnPoint _ ) As IAgCrdnVectorDisplacement

[Visual Basic .NET]

Public Function CreateDisplacementVector( _
   ByVal VectorName As String, _
   ByVal OriginPoint As IAgCrdnPoint, _
   ByVal DestPoint As IAgCrdnPoint _
) As IAgCrdnVectorDisplacement

[C#]
public IAgCrdnVectorDisplacement CreateDisplacementVector( string VectorName, IAgCrdnPoint OriginPoint, IAgCrdnPoint DestPoint );

[C#]

public IAgCrdnVectorDisplacement CreateDisplacementVector(

   string VectorName, 

   IAgCrdnPoint OriginPoint, 

   IAgCrdnPoint DestPoint

);

[Managed C++]
public: IAgCrdnVectorDisplacement^ CreateDisplacementVector( String __gc ^ VectorName, IAgCrdnPoint ^ OriginPoint, IAgCrdnPoint ^ DestPoint );

[Managed C++]

public: IAgCrdnVectorDisplacement^ CreateDisplacementVector(

   String __gc ^ VectorName, 

   IAgCrdnPoint ^ OriginPoint, 

   IAgCrdnPoint ^ DestPoint

);

[Java]
public IAgCrdnVectorDisplacement createDisplacementVector( String VectorName, IAgCrdnPoint OriginPoint, IAgCrdnPoint DestPoint );

[Java]

public IAgCrdnVectorDisplacement createDisplacementVector(

   String VectorName, 

   IAgCrdnPoint OriginPoint, 

   IAgCrdnPoint DestPoint

);

[Unmanaged C++]
public: HRESULT CreateDisplacementVector( BSTR VectorName, IAgCrdnPoint * OriginPoint, IAgCrdnPoint * DestPoint, IAgCrdnVectorDisplacement ** ReturnValue );

[Unmanaged C++]

public: HRESULT CreateDisplacementVector(

   BSTR VectorName, 

   IAgCrdnPoint * OriginPoint, 

   IAgCrdnPoint * DestPoint, 

   IAgCrdnVectorDisplacement ** ReturnValue

);

Parameters

VectorName: Specify a vector name.
OriginPoint: Specify a vector's origin point.
DestPoint: Specify a vector's destination point.

Remarks

Spaces and most punctuation ( except for "-_().") cannot be used as a part of a component name when creating new components via VGT API.

Example

Create a displacement vector defined by its origin and destination points.

[C#] Copy Code

//Create a displacement vector with two specified points 

IAgCrdnVectorDisplacement vector = provider.Vectors.Factory.CreateDisplacementVector( 

    "VectorName", OriginPoint, DestinationPoint);