Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseSpine

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

interface CATIGSMUseSpine

Interface to spine curve feature.
Role: Allows you to access data of the spine curve feature

See also:

Method Index

o AddGuide(CATIMmiMechanicalFeature_var,CATGSMLoftAddType,CATIMmiMechanicalFeature_var): Adds guide to the spine curve.
o AddSection(CATIMmiMechanicalFeature_var,CATGSMLoftAddType,CATIMmiMechanicalFeature_var): Adds the section or plane to the spine curve.
o GetAllGuides(CATLISTV(CATIMmiMechanicalFeature_var)&): Gets informations about the guides of the spine curve.
o GetAllSections(CATLISTV(CATIMmiMechanicalFeature_var)&,CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&): Gets informations about the sections of the spine curve.
o GetOrientation(enum CATGSMOrientation&): Gets the orientation.
o GetStartPoint(CATIMmiMechanicalFeature_var&): Gets the start point to the spine curve.
o ModifyGuideCurve(CATIMmiMechanicalFeature_var,CATIMmiMechanicalFeature_var): Modifies the curve of a guide from the spine curve.
o ModifySectionCurve(CATIMmiMechanicalFeature_var,CATIMmiMechanicalFeature_var): Modifies the section curve or plane of the spine curve.
o RemoveGuide(CATIMmiMechanicalFeature_var): Removes guide from the spine curve.
o RemoveSection(CATIMmiMechanicalFeature_var): Removes the section or plane from the spine curve.
o SetOrientation(enum CATGSMOrientation): Sets the orientation.
o SetStartPoint(CATIMmiMechanicalFeature_var): Sets the start point of the spine curve.

Methods

o AddGuide

public virtual AddGuide(	const	`iGuide`,
	const	`iAddType`	`= CATGSMLoftAdd` ,
	const	`iGuideRef`	`= NULL_var` )

Adds guide to the spine curve.

Parameters:

iGuide: The guide curve to be added
iAddType: The type of adding : CATGSMLoftAdd, iSection will be added at the end of the guide list. CATGSMLoftAddAfter, iGuide will be added after iGuideRef. CATGSMLoftAddBefore, iGuide will be added before iGuideRef.
iGuideRef: The guide curve used as a reference for CATGSMLoftAddAfter and CATGSMLoftAddBefore adding type

See also:

o AddSection

public virtual AddSection(	const	`iSection`,
	const	`iAddType`	`= CATGSMLoftAdd` ,
	const	`iSectionRef`	`= NULL_var` )

Adds the section or plane to the spine curve.

Parameters:

iSection: The section curve or plane to be added
iAddType: The type of adding : CATGSMLoftAdd, iSection will be added at the end of the section list. CATGSMLoftAddAfter, iSection will be added after iSectionRef. CATGSMLoftAddBefore, iSection will be added before iSectionRef.

See also:

iSectionRef

The section curve used as a reference for CATGSMLoftAddAfter and CATGSMLoftAddBefore adding type

o GetAllGuides

public virtual GetAllGuides( oGuides)

Gets informations about the guides of the spine curve.

Parameters:

oGuides: The list of the guides curves.

o GetAllSections

public virtual GetAllSections(		`oSections`,
		`oStartSectionTangent`,
		`oEndSectionTangent`)

Gets informations about the sections of the spine curve.

Parameters:

oSections: The list of the section curves.
oStartSectionTangent: The tangent surface at start section.
oEndSectionTangent: The tangent surface at end section.

o GetOrientation

public virtual GetOrientation( oOrientation)

Gets the orientation.

Parameters:

oOrientation: Orientation by reference with the normal to the first section/plane

o GetStartPoint

public virtual GetStartPoint( oPoint)

Gets the start point to the spine curve.

Parameters:

oPoint: The point used as a start point

o ModifyGuideCurve

public virtual ModifyGuideCurve(	const	`iGuide`,
	const	`iNewGuide`)

Modifies the curve of a guide from the spine curve.

Parameters:

iGuide: The guide curve to be replaced.
iNewGuide: The guide curve, will replace iGuide.

o ModifySectionCurve

public virtual ModifySectionCurve(	const	`iSection`,
	const	`iNewSection`)

Modifies the section curve or plane of the spine curve.

Parameters:

iSection: The section curve or plane to be replaced.
iNewSection: The section curve or plane, will replace iSection.

o RemoveGuide

public virtual RemoveGuide( const iGuide)

Removes guide from the spine curve.

Parameters:

iGuide: The guide curve to be removed.

o RemoveSection

public virtual RemoveSection( const iSection)

Removes the section or plane from the spine curve.

Parameters:

iSection: The section curve or plane to be removed.

o SetOrientation

public virtual SetOrientation( const iOrientation)

Sets the orientation.

Parameters:

iOrientation: Orientation by reference with the normal to the first section/plane

o SetStartPoint

public virtual SetStartPoint( const iPoint = NULL_var )

Sets the start point of the spine curve.

Parameters:

iPoint: The point to be added if no iPoint is provided, remove the start point.

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