All Frameworks Class Hierarchy This Framework Indexes Previous Next

GeometricObjects Interface CATHelix

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

interface CATHelix

Interface describing a geometric helix.
The CATHelix is created by the CreateHelix method of the CATGeoFactory interface and deleted with the CATICGMContainer::Remove method.

Method Index

o GetAngleFromParameter(CATCrvParam&,CATAngle&): From V5R21 and V6R209.
o GetAxis(CATMathLine&): Returns the axis of this CATSphere.
o GetEndAngle(): Returns the end angle of this CATSphere.
o GetParameterFromAngle(CATAngle,CATCrvParam&): Retrieves the CATCrvParam of a point defined by its angle.
o GetParameterFromZ(double,CATCrvParam&): Retrieves the CATCrvParam of a point defined by its Z coordinate.
o GetPitch(): Returns the pitch of this CATSphere.
o GetRadiusEvolution(): Returns the coefficient of linear evolution of the radius (the radius increase for one turn).
o GetRadiusLaw(CATLaw*&): Retrieves the law which defines how the radius evolves versus the helix length.
o GetStartAngle(): Returns the start angle of this CATSphere.
o GetStartingPoint(CATMathPoint&): Returns the starting point of this CATSphere.
o GetTheta0(): Retrieves the angle(in radians) which defines position of the starting point with respect to the reference CATMathVector.
o GetThetaLaw(CATLaw*&): Retrieves the law which defines the number of turns made by the helix versus its length.
o GetTrigonometricOrientation(): Returns the trigonometric orientation of this CATSphere.
o GetZFromParameter(CATCrvParam&,double&): From V5R21 and V6R209.
o GetZLaw(CATLaw*&): Retrieves the law which defines how the z coordinates evolves versus the helix length.
o Set(CATMathLine&,CATMathPoint&,CATAngle,CATAngle,double,CATLONG32,double): Modifies all the characteristics of this CATHelix.
o SetTheta0(double): Modifies the helix starting with respect to the iUnitU reference vector.
o SetTrigonometricOrientation(CATLONG32): Modifies the orientation of this CATHelix.

o HelixType: The type of helix.

Methods

o GetAngleFromParameter

public virtual GetAngleFromParameter(	const	`iParam`,
		`oAngle`)

From V5R21 and V6R209. Retrieves the angle of a point defined by its CATCrvParam.

Parameters:

iParam: The CATCrvParam.
oAngle: The angle to be retrieved.

o GetAxis

public virtual GetAxis( oAxis)

Returns the axis of this CATSphere.

Parameters:

oAxis: The CATMathLine which defines the helix axis.

o GetEndAngle

public virtual GetEndAngle(

)

Returns the end angle of this CATSphere.

Returns:: The value of the angle in radians.

o GetParameterFromAngle

public virtual GetParameterFromAngle(		`iAngle`,
		`oParam`)

Retrieves the CATCrvParam of a point defined by its angle.

Parameters:

iAngle: The angle in radians.
oParam: The CATCrvParam to be retrieved.

o GetParameterFromZ

public virtual GetParameterFromZ(		`iZ`,
		`oParam`)

Retrieves the CATCrvParam of a point defined by its Z coordinate.

Parameters:

iZ: The coordinate of the point along Oz.
oParam: The CATCrvParam to be retrieved.

o GetPitch

public virtual GetPitch(

)

Returns the pitch of this CATSphere.

Returns:: The pitch value.

o GetRadiusEvolution

public virtual GetRadiusEvolution(

)

Returns the coefficient of linear evolution of the radius (the radius increase for one turn).

Returns:: The value of the coefficient.

o GetRadiusLaw

public virtual GetRadiusLaw( const oRadiusLaw)

Retrieves the law which defines how the radius evolves versus the helix length.

Parameters:

oRadiusLaw: The CATLaw to be retrieved.

o GetStartAngle

public virtual GetStartAngle(

)

Returns the start angle of this CATSphere.

Returns:: The value of the angle in radians.

o GetStartingPoint

public virtual GetStartingPoint( oPoint)

Returns the starting point of this CATSphere.

Parameters:

oPoint: The CATMathPoint which defines the starting point.

o GetTheta0

public virtual GetTheta0(

)

Retrieves the angle(in radians) which defines position of the starting point with respect to the reference CATMathVector.

Returns:: The angle(in radians) to be retrieved.

o GetThetaLaw

public virtual GetThetaLaw( const oThetaLaw)

Retrieves the law which defines the number of turns made by the helix versus its length.

Parameters:

oThetaLaw: The CATLaw to be retrieved.

o GetTrigonometricOrientation

public virtual GetTrigonometricOrientation(

)

Returns the trigonometric orientation of this CATSphere.

Returns:: The value of the orientation: 1 (counterclockwise), -1 (clockwise).

o GetZFromParameter

public virtual GetZFromParameter(	const	`iParam`,
		`oZ`)

From V5R21 and V6R209. Retrieves the Z coordinate of a point defined by its CATCrvParam.

Parameters:

iParam: The input CATCrvParam.
oZ: The coordinate(along Z)to be retrieved.

o GetZLaw

public virtual GetZLaw( const oZLaw)

Retrieves the law which defines how the z coordinates evolves versus the helix length.

Parameters:

oZLaw: The CATLaw to be retrieved.

o Set

public virtual Set(	const	`iAxis`,
	const	`iStartingPoint`,
		`iStartAngle`,
		`iEndAngle`,
		`iPitch`,
		`iTrigonometricOrientation`,
		`iRadiusEvolution`	`= 0.`)

Modifies all the characteristics of this CATHelix.

Parameters:

iAxis: The new axis.
iStartingPoint: The new starting point.
iStartAngle: The new start angle.
iEndAngle: The new end angle.
iPitch: The new pitch.
iTrigonometricOrientation: The new trigonometric orientation.
iRadiusEvolution: The new radius evolution.

o SetTheta0

public virtual SetTheta0( iTheta0)

Modifies the helix starting with respect to the iUnitU reference vector.

Parameters:

iTheta0: Defines a starting point for the new helix. The value must be specified in radians. If 0 is specified, the starting point is located along iUnitU. Otherwise, it is shifted according to the iTheta0 value.

o SetTrigonometricOrientation

public virtual SetTrigonometricOrientation( iTrigonometricOrientation)

Modifies the orientation of this CATHelix.

Parameters:

iTrigonometricOrientation: The orientation of the rotation about the axis: 1 to turn counterclockwise, -1 to turn clockwise.

Enumerated Types

o HelixType

enum HelixType {
  ConstantPitch,
  VariablePitch
}

The type of helix.

Parameters:

ConstantPitch: Helix with a constant pitch.
VariablePitch: Helix with a variable pitch.

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

GeometricObjects Interface CATHelix

Method Index

Enumerated Type Index

Methods

Enumerated Types