CATPartUseItf Interface CATIPdgUseCircPatt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPdgUseCircPatt
Interface to read or modify the specifications of the circular pattern.
Role: The circular pattern feature allows users to duplicate an original feature according
a circular distribution.
Method Index
- o
GetDir()
- Returns the axis around which duplications will be rotated relative to each other.
- o
GetInstRot()
- Returns the boolean flag that specifies if duplications keep the same orientation.
- o
GetNa()
- Returns the position of the original feature
among its duplications along the axial direction.
- o
GetNba()
- Returns the number of times that the original feature will be duplicated along
the pattern axial direction.
- o
GetNbr()
- Returns the number of times that the original feature will be duplicated along
the pattern radial direction.
- o
GetNr()
- Returns the position of the original feature
among its duplications along the radial direction.
- o
GetParmSS()
- Returns the Stagger Step parameter.
- o
GetPto()
- Returns the point that specifies the pattern rotation center.
- o
GetSensa()
- Returns the boolean flag indicating the natural orientation of
the axial direction used to orientate the pattern operation.
- o
GetStagerStep()
- Returns the value of the Stagger Step.
- o
GetStaggerPattChoice(boolean&)
- Returns if user wants to have stagger pattern configuration.
- o
GetStaggerPattType(int&)
- Returns the orientation of Stagger Pattern.
- o
GetStepa()
- Returns the distance that separate two consecutive duplications in the pattern
along its axial direction.
- o
GetStepr()
- Returns the distance that separate two consecutive duplications in the pattern
along its radial direction.
- o
ModifyDir(CATBaseUnknown_var&)
- Sets the axis around which duplications will be rotated relative to each other.
- o
ModifyInstRot(CATBoolean)
- Sets the boolean flag that specifies if duplications keep the same orientation.
- o
ModifyPto(CATBaseUnknown_var&)
- Sets the pattern rotation center.
- o
ModifySensa(CATBoolean)
- Sets the boolean flag indicating the natural orientation of
the axial direction used to orientate the pattern operation.
- o
ModifyStaggerPattChoice(boolean)
- Modifies the choice of creation of stagger pattern configuration.
- o
ModifyStaggerPattType(int)
- Modifies the orientation of Stagger Pattern.
Methods
o GetDir
-
Returns the axis around which duplications will be rotated relative to each other.
o GetInstRot
| public virtual GetInstRot( | ) |
-
Returns the boolean flag that specifies if duplications keep the same orientation.
True to keep the same orientation of the original feature
for its duplications.
False to orientate the duplications of the original feature same
according to the radial direction.
o GetNa
-
Returns the position of the original feature
among its duplications along the axial direction.
o GetNba
-
Returns the number of times that the original feature will be duplicated along
the pattern axial direction.
o GetNbr
-
Returns the number of times that the original feature will be duplicated along
the pattern radial direction.
o GetNr
-
Returns the position of the original feature
among its duplications along the radial direction.
o GetParmSS
| public virtual GetParmSS( | ) |
-
Returns the Stagger Step parameter.
o GetPto
-
Returns the point that specifies the pattern rotation center.
o GetSensa
| public virtual GetSensa( | ) |
-
Returns the boolean flag indicating the natural orientation of
the axial direction used to orientate the pattern operation.
A value of true indicates that axial direction is the same as the natural
orientation of the selected direction.
o GetStagerStep
| public virtual GetStagerStep( | ) |
-
Returns the value of the Stagger Step.
o GetStaggerPattChoice
| public virtual GetStaggerPattChoice( | | StaggerPattChoice) |
-
Returns if user wants to have stagger pattern configuration.
- Parameters:
-
- StaggerPattChoice[out]
- *
TRUE indicates Stagger pattern configuration.
FALSE indicates conventional circular pattern configuration.
o GetStaggerPattType
| public virtual GetStaggerPattType( | | StaggerPattType) |
-
Returns the orientation of Stagger Pattern.
- Parameters:
-
- StaggerPattType[out]
- The type of orientation of staggered configuration.
1 indicates first orinetation of Stagger Pattern.
2 indicates second orinetation of Stagger Pattern.
o GetStepa
| public virtual GetStepa( | ) |
-
Returns the distance that separate two consecutive duplications in the pattern
along its axial direction.
o GetStepr
| public virtual GetStepr( | ) |
-
Returns the distance that separate two consecutive duplications in the pattern
along its radial direction.
o ModifyDir
| public virtual ModifyDir( | const | ihDir_input) |
-
Sets the axis around which duplications will be rotated relative to each other.
- Parameters:
-
- ihDir
- The line or linear edge that specifies the axis around which duplications
will be rotated relative to each other.
o ModifyInstRot
| public virtual ModifyInstRot( | | iInstRot) |
-
Sets the boolean flag that specifies if duplications keep the same orientation.
- Parameters:
-
- iInstRot
-
True to keep the same orientation of the original feature
for its duplications.
False to orientate the duplications of the original feature same
according to the radial direction.
o ModifyPto
| public virtual ModifyPto( | const | ihPto_input) |
-
Sets the pattern rotation center.
- Parameters:
-
- ihPto
- The point or vertex that specifies the pattern rotation center.
o ModifySensa
| public virtual ModifySensa( | | iSensa) |
-
Sets the boolean flag indicating the natural orientation of
the axial direction used to orientate the pattern operation.
- Parameters:
-
- iSensa
- A value of true indicates that axial direction is the same as the natural
orientation of the selected direction.
o ModifyStaggerPattChoice
| public virtual ModifyStaggerPattChoice( | | StaggerPattChoice) |
-
Modifies the choice of creation of stagger pattern configuration.
- Parameters:
-
- StaggerPattChoice[in]
-
Legal values:
TRUE indicates Stagger pattern configuration.
FALSE indicates conventional circular pattern configuration.
o ModifyStaggerPattType
| public virtual ModifyStaggerPattType( | | StaggerPattType) |
-
Modifies the orientation of Stagger Pattern.
- Parameters:
-
- StaggerPattType[in]
- The type of orientation of staggered configuration.
Legal values:
1 indicates first orinetation of Stagger Pattern.
2 indicates second orinetation of Stagger Pattern.
This object is included in the file: CATIPdgUseCircPatt.h
If needed, your Imakefile.mk should include the module: CATPartUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.