справочник по API. Справочник по api общие принципы написания программы

Скачать 82.02 Kb. Название Справочник по api общие принципы написания программы Анкор справочник по API.docx Дата 06.03.2018 Размер 82.02 Kb. Формат файла Имя файла справочник по API.docx Тип Справочник #17521 страница 1 из 4

1   2   3   4 СПРАВОЧНИК ПО API 1. Общие принципы написания программы Методы и свойства классов приложения позволяют выполнять действия, аналогичные действиям, которые выполняет пользователь при работе с приложением. Порядок выполнения методов должен соответствовать порядку соответствующих действий пользователя. 2. Основные классы приложения Объект класса SldWorks предоставляет доступ к приложению. Объект класса ModelDoc2 предоставляет доступ к документам приложения. Объект класса PartDoc предоставляет доступ к документам типа Деталь. Если в приложении активным является документ типа Деталь, одна и та же ссылка на данные объектов классов ModelDoc2 и PartDoc возвращается следующим методом класса SldWorks: Public Property ActiveDoc() As Object Объект класса ModelDocExtension предоставляет расширенный доступ к документу типа Деталь. Этот объект возвращается следующим свойством класса ModelDoc2: Public Property Extension() As ModelDocExtension Объект класса FeatureManager позволяет работать с элементами дерева построения. Этот объект возвращается следующим свойством класса ModelDoc2: Public Property FeatureManager() As FeatureManager Объект класса SketchManager предоставляет доступ к эскизам и возвращается следующим свойством класса ModelDoc2: Public Property SketchManager() As SketchManager Элементы дерева построения представляются объектами класса Feature и создаются специальными методами некоторых классов, в том числе классов FeatureManager и ModelDoc2. Такие элементы эскиза, как линия, дуга окружности (окружность), сплайн и некоторые другие представляются объектами класса SketchSegment. Точкам эскиза соответствует класс SketchPoint. Линии эскиза, дуги окружности эскиза и сплайны эскиза дополнительно представляются объектами соответственно класса SketchLine, класса SketchArc и класса SketchSpline. Свойства и методы классов SketchLine, SketchArc и SketchSpline доступны по ссылке на данные соответствующих объектов класса SketchSegment. Элементы эскиза создаются специальными методами некоторых классов, в том числе классов SketchManager и ModelDoc2. 3. Идентификация объектов элементов дерева построения Действие: чтение-запись имени элемента дерева построения. Доступ: свойство класса Feature. Описание: Public Property Name() As String Действие: чтение типа элемента дерева построения. Доступ: свойство класса Feature. Описание: Public Function GetTypeName2() As String Возвращаемое значение: 1) вырез по сечениям – “BlendCut”; 2) фаска – “Chamfer”; 3) круговой массив – “CirPattern”; 4) массив, управляемый кривой – “CurvePattern”; 5) вырез, полученный вытягиванием – “Cut”; 6) бобышка, полученная вытягиванием – “Extrusion”; 7) простое скругление – “Fillet”; 8) спираль/винтовая кривая – “Helix”; 9) вырез, созданный поворотом – “RevCut”; 10) бобышка, созданная поворотом – “Revolution”; 11) бобышка, созданная заметанием – “Sweep”; 12) вырез, созданный заметанием – “SweepCut”; 13) скругление переменного радиуса – “VarFillet”; 14) справочная ось – “RefAxis”; 15) справочная кривая – “ReferenceCurve”; 16) справочная плоскость – “RefPlane” и др. Действие: получить объект первого элемента дерева построения. Доступ: метод класса PartDoc. Описание: Public Function FirstFeature() As Object Возвращаемое значение: объект класса Feature. Действие: получить объект следующего элемента дерева построения. Доступ: метод класса Feature. Описание: Public Function GetNextFeature() As Object Возвращаемое значение: объект класса Feature. Примечание: подавленные элементы также возвращаются. Действие: получить объект последнего добавленного элемента дерева построения. Доступ: метод класса ModelDocExtension. Описание: Public Function GetLastFeatureAdded() As Feature Действие: получить грани. Доступ: метод класса Feature. Описание: Public Function GetFaces() As Variant Возвращаемое значение: одномерный массив объектов класса Face2. Действие: получить количество граней. Доступ: метод класса Feature. Описание: Public Function GetFaceCount() As Long Действие: получить кромки. Доступ: метод класса Face2. Описание: Public Function GetEdges() As Variant Возвращаемое значение: одномерный массив объектов класса Edge. Действие: получить количество кромок. Доступ: метод класса Face2. Описание: Public Function GetEdgeCount() As Long 3. Выделение Действие: снять выделение. Доступ: метод класса ModelDoc2. Описание: Public Sub ClearSelection2( _ ByVal All As Boolean _ ) Аргументы: если аргумент All равен True, то элементы убираются из всего списка выделения, если False, то элементы убираются только из активного списка выделения. Действие: выделить элемент модели. Доступ: метод класса ModelDocExtension. Описание: Function SelectByID2( _ ByVal Name As String, _ ByVal Type As String, _ ByVal X As Double, _ ByVal Y As Double, _ ByVal Z As Double, _ ByVal Append As Boolean, _ ByVal Mark As Long, _ ByVal Callout As Callout, _ ByVal SelectOption As Long _ ) As Boolean Аргументы: Name – имя элемента модели или пустая строка; Type – тип элемента модели или пустая строка; X, Y, Z – координаты точки элемента модели; если аргумент Append равен True, то невыделенный элемент модели будет добавлен к существующему выделению или выделенный элемент модели будет исключен из существующего выделения, если False, то существующее выделение будет снято и создано новое из невыделенного элемента модели или существующее выделение, включающее выделенный элемент модели, будет оставлено без изменения; Mark – номер элемента модели в выделении; Callout – объект класса Callout (или Nothing); SelectOption – опции значение из перечисления swSelectOption_e. Возвращаемое значение: True, если элемент модели стал выделенным. Примечание: 1) аргумент Type может иметь следующие значения: “DATUMPOINT” – справочная точка; “AXIS” – справочная ось; “PLANE” – справочная плоскость; “REFCURVE” – справочная кривая; “HELIX” – спираль/винтовая кривая; “SKETCH” – эскиз; “SKETCHSEGMENT” – элемент эскиза, если эскиз активен; “EXTSKETCHSEGMENT” – элемент эскиза, если эскиз неактивен; “SKETCHPOINT” – точка эскиза, если эскиз активен; “EXTSKETCHPOINT” – точка эскиза, если эскиз неактивен; “FACE” – грань; “EDGE” – кромка; “VERTEX” – вершина; “BODYFEATURE” – тело; “POINTREF” – точка; “NOTHING” – ничего; “EVERYTHING” – все; 2) аргумент Name для размера должен быть полным именем (например, “D1@[email protected]”); 3) координаты точки элемента модели должны соответствовать той системе координат, в которой элемент был создан. Элементы перечисления swSelectOption_e: swSelectOptionDefault – клавиша Shift не используется; swSelectOptionExtensive клавиша Shift используется. 4. Создание справочной геометрии дерева построения Действие: создать справочную точку. Доступ: метод класса FeatureManager. Описание: Function InsertReferencePoint( _ ByVal NRefPointType As Long, _ ByVal NRefPointAlongCurveType As Long, _ ByVal DDistance_or_Percent As Double, _ ByVal NumberOfRefPoints As Long _ ) As Variant Аргументы: NRefPointType – тип справочной точки – значение из перечисления swRefPointType_e; NRefPointAlongCurveType – тип справочной точки на кривой – значение из перечисления swRefPointAlongCurveType_e; DDistance_or_Percent – расстояние или процент длины, если аргумент NRefPointAlongCurveType равен swRefPointAlongCurveDistance или swRefPointAlongCurvePercentage соответственно; NumberOfRefPoints – количество справочных точек, если аргумент NRefPointAlongCurveType равен swRefPointAlongCurveEvenlyDistributed. Возвращаемое значение: одномерный массив объектов класса Feature. Элементы перечисления swRefPointType_e: swRefPointInvalid недействительная; swRefPointUndefined неопределена; swRefPointAlongCurve – вдоль кривой; swRefPointCenterEdge – центр кромки; swRefPointFaceCenter – центр грани; swRefPointFaceVertexProjection – проекция вершины; swRefPointIntersection пересечение. Действие: создать справочную ось. Доступ: метод класса ModelDoc2. Описание: Function InsertAxis2( _ ByVal AutoSize As Boolean _ ) As Boolean Аргументы: если аргумент AutoSize равен True, то справочная ось автоматически установит свою длину. Возвращаемое значение: True, если справочная ось была создана. Действие: создать справочную плоскость. Доступ: метод класса FeatureManager. Описание: Function InsertRefPlane( _ ByVal FirstConstraint As Long, _ ByVal FirstConstraintAngleOrDistance As Double, _ ByVal SecondConstraint As Long, _ ByVal SecondConstraintAngleOrDistance As Double, _ ByVal ThirdConstraint As Long, _ ByVal ThirdConstraintAngleOrDistance As Double _ ) As Object Аргументы: FirstConstraint – первое ограничение – значение из перечисления swRefPlaneReferenceConstraints_e; FirstConstraintAngleOrDistance – угол или расстояние для первого ограничения; SecondConstraint – второе ограничение – значение из перечисления swRefPlaneReferenceConstraints_e; SecondConstraintAngleOrDistance – угол или расстояние для второго ограничения; ThirdConstraint третье ограничение – значение из перечисления swRefPlaneReferenceConstraints_e; ThirdConstraintAngleOrDistance угол или расстояние для третьего ограничения. Возвращаемое значение: объект класса RefPlane. Примечание: до создания справочной плоскости элементы модели должны быть выделены методом SelectByID2 со следующими порядковыми номерами: 0 – первый элемент; 1 – второй элемент; 2 – третий элемент. Элементы перечисления swRefPlaneReferenceConstraints_e: swRefPlaneReferenceConstraint_Parallel параллельность; swRefPlaneReferenceConstraint_Perpendicular перпендикулярность; swRefPlaneReferenceConstraint_Coincident совпадение; swRefPlaneReferenceConstraint_Distance расстояние; swRefPlaneReferenceConstraint_Angle угол; swRefPlaneReferenceConstraint_Tangent касательность; swRefPlaneReferenceConstraint_Project – проекция точки эскиза (вершины или начала координат); swRefPlaneReferenceConstraint_MidPlane – средняя плоскость; swRefPlaneReferenceConstraint_OptionFlip реверсирование; swRefPlaneReferenceConstraint_OptionOriginOnCurve – точка плоскости на кривой; swRefPlaneReferenceConstraint_OptionProjectToNearestLocation – проекция точки эскиза (вершины или начала координат) на касательную плоскость к поверхности, ближайшую к точке эскиза (вершине или началу координат); swRefPlaneReferenceConstraint_OptionProjectAlongSketchNormal – проекция точки эскиза на касательную плоскость к поверхности по нормали эскиза. 5. Создание эскизов Действие: создать 3D эскиз или выйти из активного 3D эскиза. Доступ: метод класса SketchManager. Описание: Public Sub Insert3DSketch( _ ByVal UpdateEditRebuild As Boolean _ ) Аргументы: если аргумент UpdateEditRebuild равен True, то будут осуществлены обновление и перестройка. Действие: создать 2D эскиз или выйти из активного 2D эскиза. Доступ: метод класса SketchManager. Описание: Public Sub InsertSketch( _ ByVal UpdateEditRebuild As Boolean _ ) Аргументы: если аргумент UpdateEditRebuild равен True, то будут осуществлены обновление и перестройка. 6. Управление отображением элементов эскиза Действие: чтение-запись типа добавления элемента эскиза в базу данных. Доступ: свойство класса SketchManager. Описание: Public Property AddToDB() As Boolean Значение: True – элемент эскиза будет добавлен в базу данных напрямую, минуя отображение. Примечание: значение False по умолчанию необходимо установить до завершения работы программы. Действие: чтение-запись типа отображения элемента эскиза после его добавления в базу данных напрямую. Доступ: свойство класса SketchManager. Описание: Public Property DisplayWhenAdded() As Boolean Значение: False – элемент эскиза не будет отображен после его добавления в базу данных напрямую. Примечание: значение True по умолчанию необходимо установить до завершения работы программы. 7. Создание элементов эскиза Элемент эскиза создается только в активном эскизе. Линейные размеры задаются в м. Координата z точек элементов 2D эскиза игнорируется. Действие: создать точку эскиза. Доступ: метод класса SketchManager. Описание: Public Function CreatePoint( _ ByVal X As Double, _ ByVal Y As Double, _ ByVal Z As Double _ ) As SketchPoint Аргументы: X, Y, Z – координаты точки эскиза. Действие: создать линию эскиза. Доступ: метод класса SketchManager. Описание: Public Function CreateLine( _ ByVal X1 As Double, _ ByVal Y1 As Double, _ ByVal Z1 As Double, _ ByVal X2 As Double, _ ByVal Y2 As Double, _ ByVal Z2 As Double _ ) As SketchSegment Аргументы: X1, Y1, Z1 – координаты начала линии эскиза; X2, Y2, Z2 – координаты конца линии эскиза. Действие: создать окружность эскиза. Доступ: метод класса SketchManager. Описание: Public Function CreateCircle( _ ByVal XC As Double, _ ByVal YC As Double, _ ByVal ZС As Double, _ ByVal XP As Double, _ ByVal YP As Double, _ ByVal ZP As Double _ ) As SketchSegment Аргументы: XC, YC, ZC – координаты центра; XP, YP, ZP – координаты точки окружности эскиза. Действие: создать окружность эскиза. Доступ: метод класса SketchManager. Описание: Public Function CreateCircleByRadius( _ ByVal XC As Double, _ ByVal YC As Double, _ ByVal ZC As Double, _ ByVal Radius As Double _ ) As SketchSegment Аргументы: XC, YC, ZC – координаты центра; Radius – радиус окружности эскиза. Действие: создать дугу окружности эскиза. Доступ: метод класса SketchManager. Описание:   1   2   3   4