All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMModelInterfaces Interface CATICGMBodyFromLengthOnWire

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATICGMBodyFromLengthOnWire

Class defining an operator to create a vertex at given distance on a Wire.

The CATICGMBodyFromLengthOnWire operator follows the global frame of the topological operators and satisfies the smart mechanism: the input bodies are not modified. A new resulting body is created, possibly sharing data with the input bodies.

A CATICGMBodyFromLengthOnWire operator is created with the CATCGMCreateBodyFromLengthOnWire global method: It must be directly released with the Release method after use. It is not streamable.
If the vertex is not on the wire, then a point is computed from the input Vertex that is closest to the wire.
The length can be positive or negative. The sign of the length indicates the direction to traverse on the wire.
Options must be precised with the appropriate methods, before asking for the computation with the Run method.
The result is accessed with the GetResult method. If you do not want to keep the resulting body, use the method to remove it from the geometric factory.

Method Index

o GetLayDown(int&): Returns the lay-down setting.
o GetResult(): Returns the point body computed by the run.
o Run(): Runs the operator.
o SetLayDown(CATBody*,int): Activates or deactivates the lay-down operation.

Methods

o GetLayDown

public virtual GetLayDown( oLaid)

Returns the lay-down setting.

Parameters:

oLaid: 0 if lay-down is turned off, 1 if it is turned on.

o GetResult

public virtual GetResult(

)

Returns the point body computed by the run. Call this method after the Run method has been called.

o Run

public virtual Run(

)

Runs the operator.

Returns:: Legal values: 0 if ok, 1 if failed

o SetLayDown

public virtual SetLayDown(		`iWireBody`,
		`ilaid`)

Activates or deactivates the lay-down operation. If activated, the operator projects the resulting point body upon the specified wire body if the distance between them is lower than the factory resolution.

Parameters:

iWireBody: The wire body that is the target of the lay-down operation.
ilaid: 0 to turn off lay-down, 1 to turn it on.

This object is included in the file: CATICGMBodyFromLengthOnWire.h
If needed, your Imakefile.mk should include the module: CATGMModelInterfaces