Miscellaneous
- Last UpdatedNov 27, 2023
- 12 minute read
These Python classes are of miscellaneous types.
|
Class KcsTransformation3D.Transformation3D() |
|||||||
|
The class holds information about a 3D transformation matrix |
|||||||
|
Attributes: |
|||||||
|
Type |
integer |
Type of transformation matrix: = 0 Unknown type of matrix = 1 Matrix does not contain general scaling or projection = 2 Matrix contains general scaling = 3 Matrix contains projection |
|||||
|
element(1,1) in the matrix |
|||||||
|
Matrix11 |
real |
||||||
|
. |
|||||||
|
. |
|||||||
|
Matrix44 |
real |
element(4,4) in the matrix |
|||||
|
Methods: |
|||||||
|
SetFromTransformation |
|||||||
|
Combine |
|||||||
|
GetByRow |
|||||||
|
SetByRow |
|||||||
|
SetFromPointAndTwoVectors |
|||||||
|
SetFromPointAndThreeVectors |
|||||||
|
Invert |
|||||||
|
ReflectX |
|||||||
|
ReflectY |
|||||||
|
ReflectZ |
|||||||
|
Rotate |
|||||||
|
Translate |
|||||||
|
Examples: orig = KcsPoint3D.Point3D(0.0,0.0,0.0) |
|||||||
|
Class KcsStringlist.Stringlist(Initstring) |
|||||||
|
The class holds information about a list of strings. |
|||||||
|
Parameters: |
|||||||
|
Initstring |
string |
The first string in the list |
|||||
|
Methods: |
|||||||
|
AddString |
|||||||
|
Examples: str = 'First string' |
|||||||
|
Class KcsSymbollist.Symbollist(FontId,SymbNo) |
|||||||
|
The class holds information about a list of symbols, each represented by an integer pair denoting the font identification and the symbol number within that font. |
|||||||
|
Parameters: |
|||||||
|
FontId |
integer |
First symbol: The font identification |
|||||
|
SymbNo |
integer |
First symbol: The symbol number within the font |
|||||
|
Methods: |
|||||||
|
AddSymbol |
|||||||
|
Examples: fontid = 23 |
|||||||
|
Class KcsColour.Colour) |
|||||||
|
The class holds information about a specific colour. It is used in Vitesse functions that means, colour_set in module kcs_draft or colour_select in module kcs_ui. |
|||||||
|
Parameters and attributes: |
|||||||
|
ColourString |
string |
The name of the colour |
|||||
|
Valid colours are: "White" "Cyan" "Blue" "Magenta" "Red" "Yellow" "Green" "Black" "Wheat" "MediumAquamarine" "NavyBlue" "DarkOrchid" "FireBrick" "Orange" "ForestGreen" "DimGrey" "Tan" "Aquamarine" "SlateBlue" "Violet" "IndianRed" "Gold" "LimeGreen" "Grey" "Sienna" "Turquoise" "LightBlue" "BlueViolet" "Pink" "Coral" "SpringGreen" "LightGrey" |
|||||||
|
Constructor: |
|||||||
|
Colour (colourString) |
This constructor will create instance of Colour class. Parameter is defined as above. |
||||||
|
Class protocols: |
|||||||
|
__repr__ |
Used to return string representation of Colour object. |
||||||
|
Examples: col1 = KcsColour.Colour("Violet") |
|||||||
|
Class KcsLinetype.Linetype(LinetypeString) |
|||||||
|
The class holds information about a specific line type. |
|||||||
|
Parameters and attributes: |
|||||||
|
LinetypeString |
string |
The name of the line type. |
|||||
|
Alias names can be used as well as system names. To get all linetype names use GetLinetypes() function in KcsLinetype module. It will return python dictionary containing pairs: system name - alias name. There are also two other useful functions in KcsLinetype module: GetAliasName(name) - returns alias name for given system name, GetSystemName(name) - returns system name for given alias name. |
|||||||
|
Methods: |
|||||||
|
SetName |
|||||||
|
Name |
|||||||
|
Examples: # get system name for first alias name aliases = KcsLinetype.GetLinetypes() SysName = KcsLinetype.GetSystemName(aliases[0]) # create instances of Linetype class lt1 = KcsLinetype.Linetype(SysName) lt1_str = lt1.Name() lt2 = KcsLinetype.Linetype() lt2.SetName( lt1_str) |
|||||||
|
Class KcsModel.Model(Type,Name) |
|||||||
|
The class holds information about a specific model |
|||||||
|
Parameters and first two attributes: |
|||||||
|
Type |
string |
The model type. |
|||||
|
Valid types are: "plane panel" "hull curve" "longitudinal" "transversal" "subsurface" "lines fairing curve" "space general" "weld table" |
|||||||
|
Name |
string |
The model name. |
|||||
|
Remaining attributes: |
|||||||
|
PartType |
string |
The model part type. |
|||||
|
Valid types are: "panel" "boundary" "hole" "bracket" "plate" "notch" "seam" "stiffener" "flange" "pillar" "bead" "cutout" "excess" "hole/notch/cutout" "point" "curve" "welded joint" "unknown" |
|||||||
|
PartId |
integer |
The model part ID |
|||||
|
SubPartType |
string |
The model subpart type. |
|||||
|
Valid types are: "" "limit" "crossmark" |
|||||||
|
SubPartId |
integer |
The model subpart ID |
|||||
|
ReflCode |
integer |
Reflection code (relevant for Hull). |
|||||
|
Valid codes are: 0 = not reflected 1 = reflected |
|||||||
|
Methods: |
|||||||
|
SetType |
|||||||
|
Type |
|||||||
|
SetName |
|||||||
|
Name |
|||||||
|
PartType |
|||||||
|
PartId |
|||||||
|
SubPartType |
|||||||
|
SubPartId |
|||||||
|
ReflCode |
|||||||
|
Class KcsModelDrawAssyCriteria. ModelDrawAssyCriteria |
|||||||
|
The class holds information about assembly that will be drawn. |
|||||||
|
Parameters and attributes: |
|||||||
|
__Name |
string |
Name of assembly object. |
|||||
|
__Recursive |
integer |
Recursive/Parts mode flag |
|||||
|
__Criteria |
dictionary |
Selection criteria for model types. |
|||||
|
Methods: |
|||||||
|
Class constructor: |
This constructor will create instance of |
||||||
|
ModelDrawAssyCriteria(<name>) |
ModelDrawAssyCriteria class. name - is an assembly name. This parameter is optional. |
||||||
|
SetAssemblyName(name) |
Sets name of assembly object. |
||||||
|
GetAssemblyName() |
Returns name of assembly object. |
||||||
|
IsRecursive() |
Returns 1 if Recursive mode is selected. If it is 0 Parts mode is selected. |
||||||
|
SetRecursive(mode) |
Sets mode flag to: Recursive - if mode is 1 Parts - if mode is 0 |
||||||
|
EnableModelType(type, value) |
Enables(value=1) or disables(value=0) given model type. As type one of the following names should by used: 'PlanePanel', 'CurvedPanel', 'Pipe', 'Equipment', 'Cableway', Structure', 'PlacedVolume' or 'Ventilation'. |
||||||
|
IsModelTypeEnabled(type) |
Returns 1 if given type is enabled, otherwise it will return 0. |
||||||
|
Combine(transf) |
Performs combination of two transformations. Combines self with another transformation matrix given by transf which is another instance of Transformation2D class. |
||||||
|
Invert() |
Performs inversion of transformation matrix. |
||||||
|
Example: criteria = KcsModelDrawAssyCriteria. ModelDrawAssyCriteria ('BL-M902'); criteria.SetRecursive(1) # Recursive mode criteria.EnableModelType('PlanePanel', 0)................ # Exclude PlanePanels from selection kcs_draft.model_draw(criteria) .......................... # draw model see also: # Example: kcs_ex_draft33.py |
|||||||
|
Class KcsObject.Object |
|||||||
|
The class holds information about database object. |
|||||||
|
Parameters and attributes: |
|||||||
|
__Name |
string |
Name of object. |
|||||
|
__Code1 |
integer |
Object code 1. |
|||||
|
__Code2 |
integer |
Object code 2 |
|||||
|
__DateTime |
DateTime |
Creation date and time. |
|||||
|
__Size |
integer |
Size of object given in number of blocks (1 block = 512 bytes) |
|||||
|
Methods: |
|||||||
|
Class constructor: Object() |
This constructor will create instance of Object class. |
||||||
|
__cmp__ |
Used to compare two Object instances. |
||||||
|
__repr__ |
Used to return string representation of Object instance. |
||||||
|
SetName(string) |
Sets database object name. |
||||||
|
GetName() |
Returns name of database object. |
||||||
|
SetCode1(integer) |
Sets database object code 1. |
||||||
|
GetCode1() |
Returns database object code 1. |
||||||
|
SetCode2(integer) |
Sets database object code 2. |
||||||
|
GetCode2() |
Returns database object code 2. |
||||||
|
__SetSize(integer) |
For internal use only. |
||||||
|
GetSize() |
Returns object size in blocks. |
||||||
|
SetCreationDate(DateTime) |
Sets creation date. |
||||||
|
GetCreationDate() |
Returns creation date as DateTime instance. |
||||||
|
|
|||||||
|
Example: import KcsObject a = KcsObject.Object(05, 10, 10, 00) print a a.SetName('SP162-2') print a see also: # Example: kcs_ex_db01.py |
|||||||
|
Class KcsObjectCriteria.ObjectCriteria |
|||||||
|
The class holds information about database object selection criteria. |
|||||||
|
Parameters and attributes: |
|||||||
|
__Name |
string or None |
Name of object given with wildcards. |
|||||
|
__Code1 |
integer or None |
Object code 1. |
|||||
|
__Code2 |
integer or None |
Object code 2 |
|||||
|
__DateTime |
tuple or None |
Date and time criteria. Stored as: 1. (DateTime, DateTime) 2. (integer, DateTime) 3. None |
|||||
|
__Size |
tuple or None |
Size criteria. Stored as: 1. (integer, integer) 2. None |
|||||
|
Methods: |
|||||||
|
Class constructor: ObjectCriteria() |
This constructor will create instance of ObjectCriteria class. All criteria are set to None so all objects match criteria. |
||||||
|
__cmp__ |
Used to compare two ObjectCriteria instances. |
||||||
|
__repr__ |
Used to return string representation of ObjectCriteria instance. |
||||||
|
SetName(string) SetName(None) |
Sets name criteria or deletes it. |
||||||
|
GetName() |
Returns name criteria or None if not set. |
||||||
|
SetCode1(integer) SetCode1(None) |
Sets code1 criteria or deletes it. |
||||||
|
GetCode1() |
Returns code1 criteria or None if not set. |
||||||
|
SetCode2(integer) SetCode2(None) |
Sets code2 criteria or deletes it. |
||||||
|
GetCode2() |
Returns code2 criteria or None if not set. |
||||||
|
SetSize(integer size) SetSize(string type, integer size) SetSize(None) |
Sets size criteria: 1. Type will be set to '=' 2. Size and type selected by user 3. Criteria will be deleted Defined types for that criteria are in: ObjectCriteria.SignDefinition tuple. |
||||||
|
GetSize() |
Returns tuple: (string type, integer size) or None if not defined. |
||||||
|
SetCreationDate(DateTime start, DateTime end) SetCreationDate(string type, DateTime date) SetCreationDate(None) |
Sets creation date criteria: 1. Between dates 2. Depending on type 3. No criteria Defined types for that criteria are in: ObjectCriteria.SignDefinition tuple. |
||||||
|
GetCreationDate() |
Returns tuple: 1. (DateTime, DateTime) 2. (string type, DateTime) or None if not defined. |
||||||
|
Example: import KcsObjectCriteria from KcsDateTime import DateTime a = KcsObjectCriteria.ObjectCriteria() print a a.SetName("PLANE*") a.SetCreationDate('>=', DateTime(2000, 10, 19, 23, 00, 00, 00)) a.SetSize('<', 100) print a see also: # Example: kcs_ex_db01.py |
|||||||
|
Class KcsPrintOptions.PrintOptions(printername) |
|||||||
|
The class holds information about print options. |
|||||||
|
Parameters and attributes: |
|||||||
|
PrinterName |
string |
Printer name, empty means to use currently selected on |
|||||
|
Orientation |
integer |
Page orientation, 0 - Currently selected 1 - Portrait 2 - Landscape |
|||||
|
PrintToFile |
integer |
Activity of print-to-file option: 0 - print-to-file option set to false 1 - print-to-file option set to true |
|||||
|
FileName |
String |
File name for print result if print-to-file option is active. |
|||||
|
NoOfCopies |
integer |
Number of copies. If it is 0 than currently value will be used. |
|||||
|
EffPrintArea |
integer |
Effective print area: 0 - Currently selected 1 - Drawing Form 2 - Drawing Extension 3 - Current Window |
|||||
|
AutoOrient |
integer |
Auto-orientation flag: 0 - Use current state of flag 1 - Activate option 2 - Deactivate option |
|||||
|
ScaleToFit |
integer |
Scale-to-fit flag: 0 - Use current state of flag 1 - Activate option 2 - Deactivate option |
|||||
|
Scale |
real |
Scale value (valid only if Scale-to-fit is not selected): Figure 4:1. 0 - Use current value Figure 4:2. >0 - new value for scale |
|||||
|
printername |
string |
Initial value for PrinterName |
|||||
|
Methods: |
|||||||
|
SetPrinterName |
|||||||
|
GetPrinterName |
|||||||
|
SetOrientation |
|||||||
|
GetOrientation |
|||||||
|
SetPrintToFile |
|||||||
|
IsPrintToFile |
|||||||
|
SetNumberOfCopies |
|||||||
|
GetNumberOfCopies |
|||||||
|
SetEffectivePrintArea |
|||||||
|
GetEffectivePrintArea |
|||||||
|
SetAutoOrient |
|||||||
|
GetAutoOrient |
|||||||
|
SetScaleToFit |
|||||||
|
GetScaleToFit |
|||||||
|
SetScale |
|||||||
|
GetScale |
|||||||
|
SetFileName |
|||||||
|
GetFileName |
|||||||
|
Example: options = KcsPrintOptions.PrintOptions('\\ntsvr7\p015'); options.SetOrientation(1) options.SetScaleToFit(1) kcs_draft.dwg_print(options) see also: # Example: kcs_ex_draft27.py |
|||||||
|
Class KcsTransformation2D.Transformation2D() |
|||||||
|
The class holds information 2D transformation. |
|||||||
|
Parameters and attributes: |
|||||||
|
__type |
integer |
Type of transformation matrix. It is for internal use so if any transformation methods will be added to this class take care of setting this variable to correct value. 0 = Undefined transformation 1 = Identity transformation 2 = Transformation may also consist of translations. 3 = Transformation may also consist of rotations. 4 = Transformation may also consist of uniform scalings. 5 = Transformation may also consist of reflections. 6 = Transformation may also consist of general scalings. 7 = Transformation may also consist of skews (shears). 8 = Transformation may also consist of parallel projection. 9 = Transformation may also consist of central projection. |
|||||
|
__matrix |
list of reals |
Transformation matrix. |
|||||
|
Methods: |
|||||||
|
__Set(Row, Col, Value) |
Sets matrix item at Row and Col to Value. Row and Col must be value from 0 to 2. |
||||||
|
__Get(Row, Col) |
Gets matrix item at Row and Col. Row and Col must be value from 0 to 2. |
||||||
|
__Decompose() |
Decomposes transformation matrix to linear transformations as: scale, rotation, translation |
||||||
|
IdentityTransf() |
Initializes identity matrix. |
||||||
|
Translate(vector2D) |
Performs translation about vector vector2D which is an instance of Vector2D class. |
||||||
|
Rotate(center, angle) |
Performs rotation about center (instance of Point2D) and angle given in radians. |
||||||
|
Scale(factor) |
Performs uniform scaling by given factor. |
||||||
|
Reflect(point2D, vector2D) |
Performs reflection in a given line. Line is given by point2D and direction vector vector2D. |
||||||
|
Combine(transf) |
Performs combination of two transformations. Combines self with another transformation matrix given by transf which is another instance of Transformation2D class. |
||||||
|
Invert() |
Performs inversion of transformation matrix. |
||||||
|
GetScale() |
Returns scale factors for x and y axis as tuple of two reals. |
||||||
|
GetXYShear() |
Returns XY shear factor. |
||||||
|
GetTranslation() |
Returns translation in x and y axis as tuple of two reals. |
||||||
|
GetRotation() |
Returns rotation in radians. |
||||||
|
GetReflection() |
Returns reflection factor. |
||||||
|
Example: transformation = KcsTransformation2D.Transformation2D(); center = KcsPoint2D.Point2D(10, 10) angle = (3.1415/180) * 45........................... # 45 degrees transformation.Rotate(center, angle)................ # rotate transformation.Scale(2.0)........................... # and scale kcs_draft.element_transform(handle, transformation). # transform element see also: # Example: kcs_ex_draft31.py # Example: kcs_ex_draft34.py |
|||||||
|
Class KcsCaptureRegion2D.CaptureRegion2D() |
|||||||
|
The class holds information about 2D capture region. It is used in Vitesse capturing functions that means, model_capture and geometry_capture in module kcs_draft. |
|||||||
|
Parameters and attributes: |
|||||||
|
Inside |
integer |
Side of capturing region. If 0 all inside of contour will be included, if 1 all outside will be included. |
|||||
|
Cut |
integer |
Intersection flag. If 0 geometry intersecting the capturing region will not be included, if 1 geometry intersecting the capture region will be included. |
|||||
|
Infinite |
integer |
Infinite flag. Set to 1 if region is infinite. Reset to 0 by SetRectangle and SetContour functions. |
|||||
|
Rect |
integer |
Contour type flag. Set to 1 by SetRectangle function and reset to 0 by SetContour function (readonly as object variable). |
|||||
|
Contour |
Contour2D |
Contour defining boundary of region. Set by SetRectangle and SetContour functions (readonly as object variable). |
|||||
|
Constructor: |
|||||||
|
CaptureRegion2D() |
This constructor will create instance of CaptureRegion2D class (flags set to 1: Inside, Infi\-nite, flags reset to 0: Cut, Rect). |
||||||
|
Methods: |
|||||||
|
SetRectangle (rect) |
Sets the region based on given rectangle. It sets Contour attribute with input rectangle contour, sets Rect flag to 1 and resets Infinite flag to 0. |
||||||
|
rect |
Rectangle2D |
Capturing rectangle |
|||||
|
SetContour (cont) |
Sets the region based on given contour. It sets Contour attribute with input contour, resets Rect and Infinite flags to 0. |
||||||
|
cont |
Contour2D |
Capturing contour |
|||||
|
Class protocols: |
|||||||
|
__repr__ |
Returns string representation of CaptureRegion2D object. |
||||||
|
|
|||||||
|
Example: point1 = KcsPoint2D.Point2D(0, 0) point2 = KcsPoint2D.Point2D(100, 100) rectangle = KcsRectangle2D.Rectangle2D(point1, point2) region = KcsCaptureRegion2D.CaptureRegion2D() region.SetRectangle(rectangle) region.Inside = 1 region.Cut = 0 |
|||||||
|
|
|||||||
|
Class KcsLayer.Layer(layerid) |
|||||||
|
The class holds information about layer element. |
|||||||
|
Parameters and attributes: |
|||||||
|
__LayerId layerid |
integer integer |
Layer id. Initial value for __LayerId attribute. |
|||||
|
Methods: |
|||||||
|
SetLayer |
|||||||
|
GetLayer |
|||||||
|
GetDescription |
|||||||
|
Example: layer = KcsLayer.Layer(2) print (layer.GetDescription()) |
|||||||
|
Class KcsSymbol.Symbol(fontid, symbolid) |
|||||||
|
The class holds information about symbol element. |
|||||||
|
Parameters and attributes: |
|||||||
|
__Visible |
integer |
Visibility. If 1 symbol is visible, if 0 not. |
|||||
|
__Detectable |
integer |
Detectability. If 1 symbol is detectable, if 0 not. |
|||||
|
__Colour |
Colour |
Colour |
|||||
|
__LineType |
LineType |
LineType |
|||||
|
__Layer |
Layer |
Layer |
|||||
|
__Position |
Point2D |
Position of symbol element. |
|||||
|
__Height |
real |
Height of symbol element. |
|||||
|
__Rotation |
real |
Rotation of symbol element (in degrees). |
|||||
|
__Reflection |
integer |
Reflection of symbol element. |
|||||
|
__SymbolId |
integer |
Symbol id of symbol element. |
|||||
|
__FontId |
integer |
Font id of symbol element. |
|||||
|
Fontid |
integer |
Initial value for __FontId attribute. |
|||||
|
Symbolid |
integer |
Initial value for __SymbolId attribute. |
|||||
|
Methods: |
|||||||
|
SetFontId |
|||||||
|
GetFontId |
|||||||
|
SetSymbolId |
|||||||
|
GetSymbolId |
|||||||
|
SetDetectable |
|||||||
|
IsDetectable |
|||||||
|
SetColour |
|||||||
|
GetColour |
|||||||
|
SetLineType |
|||||||
|
GetLineType |
|||||||
|
SetLayer |
|||||||
|
GetLayer |
|||||||
|
SetPosition |
|||||||
|
GetPosition |
|||||||
|
SetHeight |
|||||||
|
GetHeight |
|||||||
|
SetRotation |
|||||||
|
GetRotation |
|||||||
|
SetVisible |
|||||||
|
InVisible |
|||||||
|
SetReflectionInUAxis |
|||||||
|
IsReflectedInUAxis |
|||||||
|
SetReflectionInVAxis |
|||||||
|
IsReflectedInVAxis |
|||||||
|
SetNoReflection |
|||||||
|
IsReflected |
|||||||
|
Example: symbolElement = KcsSymbol.Symbol(21, 2) symbolElement.SetVisible(1) reflectedInU = symbolElement.IsFeflectedInUAxis() |
|||||||
|
Class KcsText.Text(text) |
|||||||
|
The class holds information about text element. |
|||||||
|
Parameters and attributes: |
|||||||
|
__Visible |
integer |
Visibility. If 1 text is visible, if 0 not. |
|||||
|
__Detectable |
integer |
Detectability. If 1 text is detectable, if 0 not. |
|||||
|
__Colour |
Colour |
Colour |
|||||
|
__LineType |
LineType |
LineType |
|||||
|
__Layer |
Layer |
Layer |
|||||
|
__Position |
Point2D |
Position of text element. |
|||||
|
__Height |
real |
Height of text element. |
|||||
|
__Rotation |
real |
Rotation of text element (in degrees). |
|||||
|
__Aspect |
real |
Aspect ratio of text element. |
|||||
|
__Slanting |
real |
Slant ratio of text element. |
|||||
|
__Font |
string |
Font of text element. |
|||||
|
__String |
string |
String of text element. |
|||||
|
text |
string |
Parameter which defines initial __String value. |
|||||
|
Methods: |
|||||||
|
SetString |
|||||||
|
GetString |
|||||||
|
SetVisible |
|||||||
|
IsVisible |
|||||||
|
SetDetectable |
|||||||
|
IsDetectable |
|||||||
|
SetColour |
|||||||
|
GetColour |
|||||||
|
SetLineType |
|||||||
|
GetLineType |
|||||||
|
SetLayer |
|||||||
|
GetLayer |
|||||||
|
SetPosition |
|||||||
|
GetPosition |
|||||||
|
SetHeight |
|||||||
|
GetHeight |
|||||||
|
SetRotation |
|||||||
|
GetRotation |
|||||||
|
SetAspect |
|||||||
|
GetAspect |
|||||||
|
SetSlanting |
|||||||
|
GetSlanting |
|||||||
|
SetFont |
|||||||
|
GetFont |
|||||||
|
Example: text = 'example text' textElement = KcsText.Text(text) textElement.SetVisible(1) aspect = textElement.GetAspect() |
|||||||
|
Class KcsInterpretationObject.SymbolicView |
|||||||
|
The class holds information about symbolic view |
|||||||
|
Parameters and attributes: |
|||||||
|
__ViewName |
string |
View name |
|||||
|
__Looking |
constant |
Looking mode. Can be one of:
|
|||||
|
__PlaneType |
constant |
Plane type. Can be one of:
|
|||||
|
__Origin |
Point3D |
Origin point for plane definition |
|||||
|
__UAxis |
Point3D |
Uaxis for plane definition |
|||||
|
__VAxis |
Point3D |
Vaxis for plane definition |
|||||
|
__DepthBefore |
real |
Depth before |
|||||
|
__DepthAfter |
real |
Depth after |
|||||
|
__ObjectName |
string |
Panel, curve or RSO object name |
|||||
|
__CompType |
constant |
Object type. Can be one of:
|
|||||
|
__CompNo |
integer |
Number of component if object type different than SymbolicView.TYPE_PANEL |
|||||
|
__Reflect |
integer |
Reflection flag |
|||||
|
__OnlyCurrent |
integer |
Only current panel flag |
|||||
|
__LimMin |
Point3D |
Lower corner of box limits |
|||||
|
__LimMax |
Point3D |
Upper corner of box limits |
|||||
|
__ViewType |
constant |
View type. Can be one of:
|
|||||
|
__ShellCurveType |
constant |
Shell curve type. Can be one of:
|
|||||
|
__DrawRSO |
Integer |
Draw RSO flag |
|||||
|
__ShellProfiles |
Integer |
Shell profiles flag |
|||||
|
__ShellSeams |
Integer |
Shell seams flag |
|||||
|
__DrawPlaneViews |
Integer |
Draw plane views flag |
|||||
|
__DrawIntersections |
Integer |
Draw intersections flag |
|||||
|
__AutomaticSelection |
Integer |
Automatic selection flag |
|||||
|
__DrawAsPlate |
Integer |
Draw as plate flag |
|||||
|
__PanelsFilter |
List |
List of panels |
|||||
|
__PanelsExclude |
Integer |
Panels exclude flag |
|||||
|
__BlocksFilter |
List |
List of blocks |
|||||
|
__BlocksExclude |
Integer |
Blocks exclude flag |
|||||
|
__ShellCurves |
List |
List of shell curves |
|||||
|
__Assemblies |
List |
List of assemblies |
|||||
|
Methods: |
|||||||
|
SetViewName(string) |
Sets to set view name. |
||||||
|
GetViewName() |
Returns view name. |
||||||
|
SetPlaneByX(real) |
Sets plane by X coordinate. X coordinate is stored in Origin point. |
||||||
|
SetPlaneByY(real) |
Sets plane by Y coordinate. Y coordinate is stored in Origin point. |
||||||
|
SetPlaneByZ(real) |
Sets plane by Z coordinate. Z coordinate is stored in Origin point. |
||||||
|
SetPlaneBy3Points(Point3D, Point3D, Point3D) |
Sets plane by giving 3 points: origin, uaxis, vaxis. |
||||||
|
SetPlaneByPanel(panel, object_type, reflect, onlycurrent) |
Sets plane giving panel name. Object type can be one of: see description of __CompType attribute. Reflect and only current are true/false flags. |
||||||
|
SetPlaneByCurve(curve, reflect) |
Sets plane giving curve name. Reflect is a true/false flag. |
||||||
|
SetPlaneByRSO(rsoobject, compno) |
Sets plane giving rso object name and component number. |
||||||
|
GetPlaneType() |
Returns plane type. See description of __PlaneType attribute for possible values. |
||||||
|
IsReflect() |
Returns status of __Reflect flag. |
||||||
|
IsOnlyCurrent() |
Returns status of __OnlyCurrent flag. |
||||||
|
GetComponentNo() |
Returns component number. |
||||||
|
GetComponentType() |
Returns component type. See description of __CompType for possible values. |
||||||
|
GetObjectName() |
Returns name of object (panel, curve, rsoobject) |
||||||
|
SetLooking(looking) |
Sets looking mode. See description of __Looking attribute for possible values. |
||||||
|
GetLooking() |
Returns looking mode. See description of __Looking attribute for possible values. |
||||||
|
SetDepth(before, behind) |
Sets depth values. |
||||||
|
GetDepth() |
Returns depth as tuple: (before, behind) |
||||||
|
SetLimits(min3d, max3d) |
Sets box limits by two 3D points. |
||||||
|
GetLimits() |
Returns box limits as tuple of two 3D points: (min3d, max3d) |
||||||
|
SetViewType(viewtype) |
Sets view type. See description of __ViewType attribute for possible values. |
||||||
|
GetViewType() |
Returns view type. See description of __ViewType attribute for possible values. |
||||||
|
SetShellCurves(curvetype, curves=[]) |
Sets shell curves. See description of__ShellCurveType attribute for possible values of curve type. List of curves must be specified only if type of curve is: SymbolicView.CURVE_BY_NAME |
||||||
|
GetShellCurveType() |
Returns curve type. See description of __ShellCurveType attribute for possible values. |
||||||
|
GetShellCurves() |
Returns list of curve names. |
||||||
|
SetDrawRSO(integer) |
Sets status of Draw RSO flag. |
||||||
|
GetDrawRSO() |
Returns status of Draw RSO flag. |
||||||
|
SetShellProfiles(integer) |
Sets status of Shell Profiles flag. |
||||||
|
GetShellProfiles() |
Returns status of shell profiles flag. |
||||||
|
SetShellSeams(integer) |
Sets status of Shell Seams flag. |
||||||
|
GetShellSeams() |
Returns status of Shell Seams flag. |
||||||
|
SetDrawPlaneViews(integer) |
Sets status of Draw Plane Views flag. |
||||||
|
GetDrawPlaneViews() |
Returns status of Draw Plane Views flag. |
||||||
|
SetDrawIntersections(integer) |
Sets status of Draw Intersections flag. |
||||||
|
GetDrawIntersections() |
Returns status of Draw Intersections flag. |
||||||
|
SetAutomaticSelection(integer) |
Sets Automatic Selection flag. |
||||||
|
GetAutomaticSelection() |
Returns status of Automatic Selection flag. |
||||||
|
SetDrawAsPlate(integer) |
Sets Draw As Plate flag. |
||||||
|
GetDrawAsPlate() |
Returns status of Draw As Plate flag. |
||||||
|
SetPanelsFilter(panels, exclude=0) |
Sets panels filter by list of panels name and exclude flag. |
||||||
|
GetPanelsFilter() |
Returns status of panels filter. The method returns tuple: (list of panels names, exclude flag) |
||||||
|
SetBlocksFilter(blocks, exclude=0) |
Sets blocks filter by list of blocks name and exclude flag. |
||||||
|
GetBlocksFilter() |
Returns status of blocks filter. The method returns tuple: (list of blocks names, exclude flag) |
||||||
|
SetAssemblies(assemblies) |
Sets assemblies list. Valid only for ASSEMBLY view. |
||||||
|
GetAssemblies() |
Returns list of assemblies. |
||||||
|
Class KcsInterpretationObject.CurvedPanelView |
|||||||
|
The class holds information about a curved panel view. |
|||||||
|
Parameters and attributes: ([]Default setting) |
|||||||
|
Seams |
integer |
Seams in view [1=Yes]/0=No |
|||||
|
SeamNames |
integer |
Seam names in view [1=Yes]/0=No |
|||||
|
Plates |
integer |
Plates in view [1=Yes]/0=No |
|||||
|
Material |
integer |
Material specification in view 1=Yes/[0=No] |
|||||
|
Stiffeners |
integer |
Stiffeners in view [1=Yes]/0=No |
|||||
|
StiffNames |
integer |
Stiffener profile names in view 1=Yes/[0=No] |
|||||
|
ShellStiffNames |
integer |
Shell stiffener names in view 1=Yes/[0=No] |
|||||
|
PartNames |
integer |
Part names (stiffener) in view 1=Yes/[0=No] |
|||||
|
Endcuts |
integer |
Display endcuts in view 1=Yes/[0=No] |
|||||
|
Jigs |
integer |
Display jigs in view [1=Yes]/0=No |
|||||
|
Heights |
integer |
Display jig heights in view 1=Yes/[0=No |
|||||
|
FrameCurves |
integer |
Frame curves in view 1=Yes/[0=No] |
|||||
|
FrameCurvesNames |
integer |
Names of frame curves in view 1=Yes/[0=No] |
|||||
|
DirectionMarks |
integer |
Direction marks in view 1=Yes/[0=No] |
|||||
|
HoleCrossMarks |
integer |
Hole crossmarks in view 1=Yes/[0=No] |
|||||
|
Methods: |
|||||||
|
Property set/get methods. |
|||||||
|
SetSeams (integer) |
|||||||
|
GetSeams () |
|||||||
|
SetSeamsNames (integer) |
|||||||
|
GetSeamsNames () |
|||||||
|
SetPlates (integer) |
|||||||
|
GetPlates () |
|||||||
|
SetMaterial (integer) |
|||||||
|
GetMaterial () |
|||||||
|
SetStiffeners (integer) |
|||||||
|
GetStiffeners () |
|||||||
|
SetStiffNames (integer) |
|||||||
|
GetStiffNames () |
|||||||
|
SetEndcuts (integer) |
|||||||
|
GetEndcuts () |
|||||||
|
SetJigs (integer) |
|||||||
|
GetJigs () |
|||||||
|
SetHeights (integer) |
|||||||
|
GetHeights () |
|||||||