本文档提供了 V-SuiteCORE2021 的 MacroAPI 完整指南，涵盖各类资产、知识视图、显示过滤器等的创建、管理与操作方法。深入介绍了资产文档、资产类方法、属性、模板、数据库交互及权限控制等功能。
V-Suite CORE 2021 - Macro API Documentation 中文
- Class
- Class Index
- Assemblies（程序集：程序集用于将一系列资产连接到其他资产）
- AssetDocument （资产文档：资产文档类）
- Assets（资产：实现资产静态API方法）
- 方法
- AddDocument() （将文档添加到资产。）
- AddScanImage() （将图像名称添加到扫描/区域资产。）
- BreakJoin() （中断两个资产之间的连接。）
- ClearCatalog() （清除资产目录。）
- CompareAssets() （通过比较其物理签名来比较2个资产。）
- ConnectAssets() （连接PADL驱动的资产。）
- CopyAsset() （在指定的父节点复制资产。）
- CreateAsset() [1/2] （创建一个新资产。）
- CreateAsset() [2/2] （创建一个新资产。）
- DeleteAsset() （从数据库中删除指定的资产。）
- FlipAsset() （翻转资产。）
- GetAdapterAttributes()（获取适配器参数。）
- GetAssetAppearance()（获取指定资产的外观。）
- GetAssetName()（获取指定资产的名称。）
- GetAssetTemplateOf()（获取指定资产的模板。）
- GetAssetType()（获取资产文件夹类型。）
- GetAttachedAsset()（在指定工作区获取附加到资产的标记点。注：资产必须是一个标记点。）
- GetAttachedObject()（获取附加到对象的标记点。注：资产必须是一个标记点。）
- GetAttachedPrimitive()（获取附加到原始的标记点。注：资产必须是一个标记点。）
- GetAttributeMap()（获取指定资产的指定属性集的属性值。）
- GetAttributeValue()（获取指定资产的指定属性的属性值。）
- GetBoundingBox()（获取指定资产的边界框。）
- GetCatalog()（检查传递的资产是否由目录驱动。）
- GetCatalogInstanceName() （获取资产的目录实例名。）
- GetCatalogItemOfAsset()（获取资产的目录项。）
- GetChildren()（获取指定资产的子元素。）
- GetCitizen()（获取共享资产的公民。）
- GetClosestConnectionPoint()（获取资产到给定位置的最近连接点。）
- GetConnectedAssets() [1/2]（获取连接到指定资产的资产。）
- GetConnectedAssets() [2/2]（根据流的方向获取连接到指定资产的资产。）
- GetDisplayFilters()（获取包含传递的资产的所有显示筛选器。）
- GetDocument() （获取基于名称与资产关联的文档。）
- GetDocuments()（获取与资产关联的文档列表。）
- GetKnowledgeViews()（获取包括传递的资产的所有知识视图。）
- GetPADLPrimitives()（获取PADL驱动资产的基元。）
- GetParent()（获取指定资产的父级。）
- GetPhysicalPropertyValue()（获取物理属性的值。）
- GetPrimitives()（获取指定资产的基元。）
- GetScanImageNames()（从扫描资产或区域资产获取图像名称。）
- GetSharedAssets()（获取资产的共享。）
- GetWorkspace()（获取指定资产的工作区。）
- HasGraphicChildren()（验证指定的资产是否具有图形子资产。）
- HasTemplateTag()（验证指定资产是否具有已分配指定标记的模板。）
- InsertAsset()（在指定的位置将某个模板的资产插入到另一个资产中。）
- IsActive()（验证资产是否处于活动状态。）
- IsAsset()（检查传递的资产是否为资产。）
- IsCatalogDriven()（检查传递的资产是否由目录驱动。）
- IsConnected()（资产是否完全连接。它检查所有连接点是否连接到其他资产。如果资产没有连接点，它也不连接。）
- IsLogical()（验证指定的资产是否是逻辑资产。）
- IsPointCloud()（资产是否为点云类(激光扫描或区域)。）
- IsTemporary()（验证指定的资产是否是临时资产。）
- JoinAssets() [1/2]（连接两个给定公差的资产。首先列出的资产最有可能被修改。）
- JoinAssets() [2/2]（连接两个给定公差的资产。）
- MoveAssets()（通过在组件中传递的转换去移动资产。）
- RemoveDocument()（从资产中删除文档。）
- RemoveScanImage()（删除扫描/区域资产的图像名称。）
- SetAssetActive()（设置资产的属性值。）
- SetAssetAppearance()（设置资产的外观。）
- SetAssetName()（设置资产的属性值。）
- SetAttachedObject()（设置附加到对象上的标记点。注：资产必须是一个标记点。）
- SetAttributeValue()（设置资产的属性值。）
- SetCatalog()（设置资产目录并找到最接近的匹配项。）
- SetCatalogInstance()（设置资产的目录实例。）
- SetParent()（设置资产的父级。）
- SetPhysicalPropertyValue()（设置资产的属性值。）
- SetProp()（按属性名设置属性值。）
- SetPropertyValue()（设置资产的属性值。）
- ShareAsset()（将一项资产共享父类）
- Constants.BackgroundScene（为透视知识视图提供更多的背景场景类型）
- BoundingBox（用于区段的脚本包装器）
- Constants.BoxProperties（框属性的名称）
- Constants.CameraDirection（知识视图的摄像机指示）
- Constants.CameraType（用于知识视图的摄像机类型）
- Catalog（实现各种静态目录API方法）
- Circle3d（执行圆操作的工具类）
- Constants.ConeProperties (圆锥的属性名称)
- Constants.ConnectionType（连接资产的类型）
- Constants（常量的描述）
- Constants.CylinderProperties （气罐的属性名称）
- Database （实现各种静态数据的API方法）
- 方法
- GetAppearance()（从数据中获取外观。）
- GetAppearanceIds()（未发布方法用于获取测试的所有外观的ID。）
- GetAssetTemplate()（从数据结构获取模板）
- GetAttributeSetTemplate()（从数据结构中获取属性集模板）
- GetAttributeTemplate()（从数据结构获取属性模板）
- GetCatalog()（根据目录名称获取目录。）
- GetCatalogInstance()（获取具有指定名称的目录实例）
- GetCatalogItem()（获取模板的目录）
- GetDataConnection()（从数据中获取外部数据连接。）
- GetDisplayFilterIds()（方法获取所有显示筛选器的ID。用于测试。）
- GetKnowledgeViewIds()（获取所有知识视图的ID的未发布方法。用于测试。）
- GetSearchDefinition()（从数据库中获取搜索定义。）
- GetSearchDefinitionIds()（方法获取所有搜索定义的ID。用于测试。）
- GetTemplateName()（获取模板的名称。）
- GetWorkspace()（从数据库中获取工作区）
- GetWorkspaceIds()（方法获取所有工作区的ID。用于测试。）
- IsTemplateTemporary()（验证从指定模板中实例化的资产是否为临时资产）
- IsWorkspace() （测试传递的Id是否属于工作区）
- UpdateCatalogFromXml()（从导出的目录XML文件更新现有目录的未发布方法。）
- DataReader（实现GDA数据读取器类。）
- Constants.DishProperties（盘属性名称）
- DisplayFilters（实现静态API显示过滤器方法）
- 方法
- CreateDisplayFilter()（在带有外观的工作区上创建具有指定名称的显示筛选器。）
- CreateDisplayFilterFolder()（在父文件夹上创建具有指定名称的显示筛选器文件夹。）
- DeleteDisplayFilter()（删除具有指定id的显示筛选器 ）
- GetDisplayFilter()（获取父级上具有指定名称的显示筛选器。）
- GetDisplayFilterAssets()（获取与显示筛选器关联的资产。）
- GetDisplayFilterFolder()（获取指定父节点上具有指定名称的显示筛选器文件夹。）
- GetDisplayFilterName()（获取显示筛选器的名称。）
- UpdateDisplayFilter()（使用新资产更新具有指定id的显示筛选器。）
- DisplayList （返回要显示的对象列表的实用程序类。）
- Constants.DisplayStyle（显示的类型）
- Helpers（实现静态API帮助器方法）
- Constants.IShapeProperties（I形状的属性名称）
- KeyValueMap（哈希表的实用程序类）
- KnowledgeViews（为知识视图上的操作实现静态方法）
- 方法
- AddAsset()（将资产添加到特定的知识视图。预览没有为视图更新。）
- AddFilter()（向特定的知识视图添加筛选器。预览没有为视图更新。）
- CreateKnowledgeView() [1/4]（在父视图上创建具有指定名称的知识视图。）
- CreateKnowledgeView() [2/4]（在父视图上创建具有指定名称的知识视图。）
- CreateKnowledgeView() [3/4]（在父视图上创建具有指定名称的知识视图。）
- CreateKnowledgeView() [4/4]（在父视图上创建具有指定名称的知识视图。）
- CreateKnowledgeViewFolder()（创建父目录上具有指定名称的知识视图文件夹。）
- CreateNonConsolidatedKnowledgeView()（创建一个已禁用资产整合的知识视图。）
- GetAssets()（获取包含在知识视图中的所有资产。）
- GetDisplayFilters()（获取知识视图中所有活动的显示筛选器。）
- GetFolder()（获取指定父目录下具有指定名称的文件夹。）
- GetName()（获取知识视图的名称。）
- GetParent()（获取指定的知识视图或文件夹所在的文件夹。）
- GetView()（获取在特定父级下具有指定名称的知识视图。）
- GetViews()（获取指定工作区中的所有知识视图。）
- RemoveFilters()（从知识视图中移除所有过滤器。）
- SetAssets()（设置知识视图的资产。删除以前的资产。预览没有为视图更新。）
- SetBackgroundColor()（设置知识视图的背景颜色。）
- SetBackgroundScene()（设置知识视图的背景场景。）
- SetBoundingBox()（设置知识视图的边框标志。）
- SetCameraDirection()（设置知识视图的摄像机方向。）
- SetCameraType()（设置知识视图的摄像机类型。）
- SetDescription()（设置知识视图的描述。）
- SetDisplayStyle()（设置知识视图的显示样式。）
- SetName()（设置知识视图的名称。）
- SetParent()（设置知识视图的父视图。）
- SetShowTags()（设置知识视图的展示标签标志。）
- SetShowTagsByTemplate()（通过模板设置知识视图的展示标签标志。）
- Constants.LShapeProperties（形状属性的名称）
- Messages（实现静态API消息方法）
- ObjectList（返回对象列表的实用程序类）
- ObjectsPropertyList（对象，该对象由附加程序集宏返回。提供关于宏创建的资产和资产的放置选项的信息。）
- Orthonormal（用于标准正交(普通XYZ轴)的脚本包装器类）
- Permissions（实现静态API信息 方法）
- Primitives（用于基本操作的主类。）
- 方法
- CopyPrimitives()（克隆基元 未发布方法。）
- CreatePrimitive()（创建一个新的基元。）
- DeletePrimitive()（删除基元）
- DeletePrimitives()（删除基元）
- GetBoundingBox()（获取指定基元的边框。）
- GetParent()（获取指定基元的父元素。）
- GetPhysicalSignature()（必须返回物理签名的基元ID。）
- GetPrimitivePropertyValue()（获取一个基元属性。）
- GetPrimitiveTemplateNameOf()（获取指定基元的基元模板名称。）
- SetParent()（设置基元的父元素。）
- SetPrimitivePropertyValue()（设置基本属性。）
- SplitExtrusion()（将挤出物分成单独的型材。）
- ProjectPreferences（实现工程选项静态API 方法）
- Constants.PyramidProperties（棱锥属性名称）
- Search（实现搜索静态API方法）
- Constants.SphereProperties（球体属性名称）
- Constants.ToroidProperties（螺旋管属性的名称）
- Constants.TorusProperties（环面属性的名称）
- Constants.TShapeProperties（T形状属性的名称）
- Constants.TypeNames（资产或基本类型的名称）
- UserInterface（实现用户界面方法）
- UserPreferences（实现用户选项静态API方法）
- Constants.UShapeProperties（U形状的属性名称）
- Utilities（实现静态API集成方法）
- Vector（用于Db3dVector的脚本包装器。）
- 属性
- 方法
- Vector() [1/2]（默认构造函数）
- Vector() [2/2]（默认构造函数）
- Angle()（计算两个向量之间的夹角。）
- ApplyTransformation()（对向量进行变换。）
- ConvertDirectionToSite()（将当前方向转换为数据库全局方向）
- ConvertPositionToSite()（将当前位置转换为数据库全局位置）
- CrossProduct()（计算两个向量的外积。）
- DotProduct()（计算两个向量的点积。）
- Equals()（比较是否相同）
- GetDirectionString()（获取属性对话框中显示的字符串方向。）
- GetDistance()（获取两个向量(位置)之间的距离。）
- GetHashCode()（获取基于向量XYZ值的向量哈希码。）
- GetPositionString()（获取不包含单元的属性对话框中显示的字符串位置。）
- Normalize()（使这个向量规范化。）
- operator!=()（不相等运算符。）
- operator*() [1/2]（乘法运算符。）
- operator*() [2/2]（乘法运算符。）
- operator+() [1/2]（加法运算符。）
- operator+() [2/2]（加法运算符。）
- operator-()（减法运算符。）
- operator/()（除法操作符。）
- operator==()（相等操作符。）
- Rotate()（旋转这个向量。）
- ViewerList（返回对象列表的实用程序类）
- Vnf（用于VNF操作的API类）
- 方法
- CloneAttributeSet()（将临时VNF模板的属性克隆到数据库模板。）
- GetAssetPrimitiveData()（获取指定资产的原始数据。）
- GetAssetsByAttributeValue()（获取属性为‘attributeName’等于‘attributeValue’的资产。）
- GetAssetsByName()（获取具有指定名称的资产。）
- GetAssetsByType()（获取其VNF具有指定命名空间和其固有类型属性为“typeOrAlias”的资产。）
- GetAttributeMap()（获取指定附加资产和属性集的属性值。）
- GetAttributeValue()（获取指定附加资产的属性值。）
- GetChildren()（获取指定的VNF文件或附加资源的子资源的id。）
- GetParent()（获取指定的VNF文件或附加资源的父资源的ID。）
- GetPrimitiveData()（获取指定资产的原始数据。）
- GetPrimitivePropertyValue()（获取一个原始属性。）
- GetPrimitives()（获取附加的VNF资产的指定资产的原始id。）
- GetPrimitiveTemplateNameOf()（获取附加资产的原语的指定原语id的模板名称。）
- GetPropertyValue()（获取指定的VNF文件或附加资产的固有属性值。）
Class
Class Index
Assemblies（程序集：程序集用于将一系列资产连接到其他资产）
方法
CreateAttachment() （创建指定资产的附件。）
static ulong CreateAttachment ( ulong existingAsset,string existingSnapPoint,ulong newAssetTemplate,string newSnapPoint)
- 参数：
ulong existingAsset：要附加到的现有资产的ID
string existingSnapPoint：将附加新资产的快照点的名称
ulong newAssetTemplate：要创建的资产的模板
string newSnapPoint：要附加到的新资产上的快照点的名称 - 返回:
类型：ulong
值：新连接资产的ID
AssetDocument （资产文档：资产文档类）
属性
string Name [get] 名称
string Path [get] 路径
string Description[get] 描述
方法
AssetDocument() （初始化AssetDocument类的新实例。）
AssetDocument ( string name, string path, string description = “”)
- 参数：
string name：初始化的名称
string path：初始化的路径
string description ：初始化的描述 - 返回:
无
Assets（资产：实现资产静态API方法）
方法
AddDocument() （将文档添加到资产。）
static bool AddDocument ( ulong assetId, string name, string path, string description)
- 参数：
ulong assetId：资产标识符
string name：初始化的名称
string path：完整路径
string description ：初始化的描述 - 返回:
类型：bool
值：如果添加了文档，返回true
AddScanImage() （将图像名称添加到扫描/区域资产。）
static bool AddScanImage ( ulong assetId, string fileName)
- 参数：
ulong assetId：资产标识符
string fileName：文件名称 - 返回:
类型：bool
值：如果添加了成功，返回true
BreakJoin() （中断两个资产之间的连接。）
static bool BreakJoin ( ulong asset1Id, ulong asset2Id)
- 参数：
ulong asset1Id：要断开连接的资产之一的id
ulong asset2Id：要断开连接的资产之一的id - 返回:
类型：bool
值：如果2个资产断开了，返回true
ClearCatalog() （清除资产目录。）
static bool ClearCatalog (ulong assetId)
- 参数：
ulong assetId：资产的id - 返回:
类型：bool
值：如果修改了则为true否则false
CompareAssets() （通过比较其物理签名来比较2个资产。）
static bool CompareAssets (ulong asset1Id, ulong asset2Id)
- 参数：
ulong asset1Id：要比较的第一个资产的ID
ulong asset2Id：要比较的第二个资产的ID - 返回:
类型：bool
值：如果修改了则为true否则false
ConnectAssets() （连接PADL驱动的资产。）
static bool ConnectAssets ( ulong [] assetIds, bool bShowProgress)
- 参数：
ulong [] assetIds：要连接的资产id数组。
bool bShowProgress： 是否在连接资产的操作期间显示进度。 - 返回:
类型：bool
值：如果成功连接则为true否则false
CopyAsset() （在指定的父节点复制资产。）
static ulong CopyAsset (ulong assetId, ulong parentId)
- 参数：
ulong assetId：资产id。
ulong parentId： 新父节点的ID。 - 返回:
类型：ulong
值：资产副本的ID
CreateAsset() [1/2] （创建一个新资产。）
static ulong CreateAsset (ulong assetTemplateId, ulong parentId, string assetName, bool isDuplicate)
- 参数：
ulong assetTemplateId：新资产模板的ID。
ulong parentId： 新父节点的ID。
string assetName：新资产名称
bool isDuplicate：是否允许重复名称。 - 返回:
类型：ulong
值：新资产的ID
CreateAsset() [2/2] （创建一个新资产。）
static ulong CreateAsset (ulong assetTemplateId, ulong parentId)
- 参数：
ulong assetTemplateId：新资产模板的ID。
ulong parentId： 新父节点的ID。 - 返回:
类型：ulong
值：新资产的ID
DeleteAsset() （从数据库中删除指定的资产。）
static bool DeleteAsset (ulong assetId)
- 参数：
ulong assetId：要删除的资产ID。 - 返回:
类型：bool
值：成功删除返回true否则false
FlipAsset() （翻转资产。）
static bool FlipAsset (ulong assetId)
- 参数：
ulong assetId：要翻转的资产id。 - 返回:
类型：bool
值：如果资产被翻转，则为真。
GetAdapterAttributes()（获取适配器参数。）
static VariableTable GetAdapterAttributes (ulong assetId, string attributeSetName)
- 参数：
ulong assetId：资产id。
string attributeSetName：要获取的适配器属性集的名称。 - 返回:
类型：VariableTable
值：具有属性名和值的可变表。如果对象不是适配器项，则可能返回null。
GetAssetAppearance()（获取指定资产的外观。）
static ulong GetAssetAppearance (ulong assetId)
- 参数：
ulong assetId：必须为其返回外观的资产ID。 - 返回:
类型：ulong
值：外观id或0(如果无效)
GetAssetName()（获取指定资产的名称。）
static string GetAssetName (ulong assetId)
- 参数：
ulong assetId：必须为其返回名称的资产ID。 - 返回:
类型：string
值：资产名称
GetAssetTemplateOf()（获取指定资产的模板。）
static ulong GetAssetTemplateOf (ulong assetId)
- 参数：
ulong assetId：必须返回模板的资产的ID。 - 返回:
类型：ulong
值：模板ID或0(如果无效)。
GetAssetType()（获取资产文件夹类型。）
static string GetAssetType (ulong assetId)
- 参数：
ulong assetId：必须为其返回类型的资产的ID。 - 返回:
类型：string
值：资产类型
GetAttachedAsset()（在指定工作区获取附加到资产的标记点。注：资产必须是一个标记点。）
static ulong GetAttachedAsset (ulong markedPointId, ulong workspace)
- 参数：
ulong markedPointId：资产的ID，它必须是一个标记点。
ulong workspace：资产所在工作区的ID。 - 返回:
类型：ulong
值：资产id或0（如果标记的点没有附加到工作区中。）
GetAttachedObject()（获取附加到对象的标记点。注：资产必须是一个标记点。）
static ulong GetAttachedObject (ulong markedPointId)
- 参数：
ulong markedPointId：资产的ID，它必须是一个标记点。 - 返回:
类型：ulong
值：原始id或0（如果标记的点没有附加到原始上。）
GetAttachedPrimitive()（获取附加到原始的标记点。注：资产必须是一个标记点。）
static ulong GetAttachedPrimitive (ulong markedPointId)
- 参数：
ulong markedPointId：资产的ID，它必须是一个标记点。 - 返回:
类型：ulong
值：原始id或0（如果标记的点没有附加到原始上。）
GetAttributeMap()（获取指定资产的指定属性集的属性值。）
static KeyValueMap GetAttributeMap ( ulong assetId, ulong attributeSetTemplateId)
- 参数：
ulong assetId：必须返回属性值的资产的ID。
ulong attributeSetTemplateId：必须为其返回值的属性集模板的ID。 - 返回:
类型：KeyValueMap
值：属性名称和值的map。
GetAttributeValue()（获取指定资产的指定属性的属性值。）
static object GetAttributeValue (ulong assetId, ulong attributeTemplateId)
- 参数：
ulong assetId：必须返回属性值的资产的ID。
ulong attributeSetTemplateId：必须为其返回值的属性集模板的ID。 - 返回:
类型：KeyValueMap
值：指定资产的指定属性的属性值。
GetBoundingBox()（获取指定资产的边界框。）
static BoundingBox GetBoundingBox (ulong assetId)
- 参数：
ulong assetId：必须返回边界框的资产的ID。 - 返回:
类型：BoundingBox
值：资产名称。
GetCatalog()（检查传递的资产是否由目录驱动。）
static string GetCatalog (ulong assetId)
- 参数：
ulong assetId：用于检查是否为目录驱动的资产的ID。 - 返回:
类型：string
值：资产使用的目录名
GetCatalogInstanceName() （获取资产的目录实例名。）
static string GetCatalogInstanceName (ulong assetId)
- 参数：
ulong assetId：对象的id。 - 返回:
类型：string
值：目录的ID或空字符串（如果没有找到）
GetCatalogItemOfAsset()（获取资产的目录项。）
static ulong GetCatalogItemOfAsset (ulong assetId)
- 参数：
ulong assetId：资产的id。 - 返回:
类型：ulong
值：目录项的id或0（如果没有找到资产，或者没有目录驱动）
GetChildren()（获取指定资产的子元素。）
static ulong [] GetChildren (ulong assetId)
- 参数：
ulong assetId：必须返回子元素的资产的ID。 - 返回:
类型：ulong []
值：子资产的id数组
GetCitizen()（获取共享资产的公民。）
static ulong GetCitizen (ulong asset)
- 参数：
ulong asset：用于返回资产的资产。 - 返回:
类型：ulong
值：共享资产公民
GetClosestConnectionPoint()（获取资产到给定位置的最近连接点。）
static Vector GetClosestConnectionPoint (ulong assetId, Vector point)
- 参数：
ulong assetId：要返回连接点的资产的ID
Vector point：针对所有资产连接点进行测试的点。 - 返回:
类型：Vector
值：具有最近连接点的向量。
GetConnectedAssets() [1/2]（获取连接到指定资产的资产。）
static ulong [] GetConnectedAssets (ulong assetId)
- 参数：
ulong assetId：必须为其返回连接资产的资产的ID。 - 返回:
类型：ulong []
值：连接的资产ID的数组。
GetConnectedAssets() [2/2]（根据流的方向获取连接到指定资产的资产。）
static ulong [] GetConnectedAssets (ulong assetId, string connectionType)
- 参数：
ulong assetId：必须为其返回连接资产的资产的ID。
string connectionType：连接类型，即“入口”和“出口”。 - 返回:
类型：ulong []
值：连接的资产ID的数组。
GetDisplayFilters()（获取包含传递的资产的所有显示筛选器。）
static ulong [] GetDisplayFilters (ulong assetId, ulong workspaceId)
- 参数：
ulong assetId：获取过滤器的资产。
ulong workspaceId：获取过滤器的工作区。 - 返回:
类型：ulong []
值：指定工作区中的显示筛选器列表。
GetDocument() （获取基于名称与资产关联的文档。）
static AssetDocument GetDocument (ulong assetId, string name)
- 参数：
ulong assetId：资产标识符
string name ：文档的名称。 - 返回:
类型：AssetDocument
值：使用相同名称找到的第一个文档
GetDocuments()（获取与资产关联的文档列表。）
static AssetDocument [] GetDocuments (ulong assetId)
- 参数：
ulong assetId：资产标识符 - 返回:
类型：AssetDocument []
值：与资产关联的文档列表
GetKnowledgeViews()（获取包括传递的资产的所有知识视图。）
static ulong [] GetKnowledgeViews (ulong assetId, ulong workspaceId)
- 参数：
ulong assetId：获取视图的资产。
ulong workspaceId：获取视图的工作区。 - 返回:
类型：ulong []
值：指定工作区中的视图列表。
GetPADLPrimitives()（获取PADL驱动资产的基元。）
static ulong [] GetPADLPrimitives (ulong assetId)
- 参数：
ulong assetId：PADL驱动资产的id。 - 返回:
类型：ulong []
值：基元ID的数组。
GetParent()（获取指定资产的父级。）
static ulong GetParent (ulong assetId)
- 参数：
ulong assetId：必须返回父类的资产的ID。 - 返回:
类型：ulong
值：父级资产ID。
GetPhysicalPropertyValue()（获取物理属性的值。）
static object GetPhysicalPropertyValue (ulong asset, string propertyName)
- 参数：
ulong asset：必须返回属性值的资产。
string propertyName：物理属性的名称。 - 返回:
类型：object
值：属性的值
GetPrimitives()（获取指定资产的基元。）
static ulong [] GetPrimitives (ulong assetId)
- 参数：
ulong assetId：必须返回基元的资产的ID。 - 返回:
类型：ulong []
值：基元ID的数组。
GetScanImageNames()（从扫描资产或区域资产获取图像名称。）
static string [] GetScanImageNames (ulong assetId)
- 参数：
ulong assetId：资产标识符。 - 返回:
类型：string []
值：图像名称列表
GetSharedAssets()（获取资产的共享。）
static ulong [] GetSharedAssets (ulong asset)
- 参数：
ulong asset：返回共享的资产的ID。 - 返回:
类型：ulong []
值：所有共享资产的列表。
GetWorkspace()（获取指定资产的工作区。）
static ulong GetWorkspace (ulong assetId)
- 参数：
ulong assetId：必须为其返回工作区的资产的ID。 - 返回:
类型：ulong
值：资产的工作区ID。
HasGraphicChildren()（验证指定的资产是否具有图形子资产。）
static bool HasGraphicChildren (ulong assetId)
- 参数：
ulong assetId：必须验证图形子元素的资产的ID。 - 返回:
类型：bool
值：如果有子图形返回true,否则false
HasTemplateTag()（验证指定资产是否具有已分配指定标记的模板。）
static bool HasTemplateTag (ulong assetId, string tagName)
- 参数：
ulong assetId：要验证的资产的ID。
string tagName：分配给资产模板的标记。 - 返回:
类型：bool
值：如果资产的模板指定了标记，则为true。否则false。
InsertAsset()（在指定的位置将某个模板的资产插入到另一个资产中。）
static ulong InsertAsset (ulong templateId, ulong assetId, Vector insertPoint)
- 参数：
ulong templateId：要插入的资产类型。
ulong assetId：要插入的资产的id。
Vector insertPoint：插入点。 - 返回:
类型：ulong
值：如果插入成功则插入资产的id，否则为0。
IsActive()（验证资产是否处于活动状态。）
static bool IsActive (ulong assetId)
- 参数：
ulong assetId：必须验证的资产的ID。 - 返回:
类型：bool
值：如果该资产是不活动的临时资产，则为false，否则为true。
IsAsset()（检查传递的资产是否为资产。）
static bool IsAsset (ulong assetId)
- 参数：
ulong assetId：要检查的资产的ID。 - 返回:
类型：bool
值：如果资产是资产，则为true。
IsCatalogDriven()（检查传递的资产是否由目录驱动。）
static bool IsCatalogDriven (ulong assetId)
- 参数：
ulong assetId：用于检查是否为目录驱动的资产的ID。 - 返回:
类型：bool
值：如果资产是目录驱动的，则为true。
IsConnected()（资产是否完全连接。它检查所有连接点是否连接到其他资产。如果资产没有连接点，它也不连接。）
static bool IsConnected (ulong assetId)
- 参数：
ulong assetId：检查连接的资产。 - 返回:
类型：bool
值：如果资产在所有连接点上完全连接，则为True。
IsLogical()（验证指定的资产是否是逻辑资产。）
static bool IsLogical (ulong assetId)
- 参数：
ulong assetId：要验证的资产的ID。 - 返回:
类型：bool
值：如果资产符合逻辑，则为true，否则为false。
IsPointCloud()（资产是否为点云类(激光扫描或区域)。）
static bool IsPointCloud (ulong assetId)
- 参数：
ulong assetId：要检查的资产的ID。 - 返回:
类型：bool
值：如果传递的ID属于点云类型资产，则为True。
IsTemporary()（验证指定的资产是否是临时资产。）
static bool IsTemporary (ulong assetId)
- 参数：
ulong assetId：要验证的资产的ID。 - 返回:
类型：bool
值：如果资产是临时的，则为true，否则为false。
JoinAssets() [1/2]（连接两个给定公差的资产。首先列出的资产最有可能被修改。）
static bool JoinAssets (ulong asset1Id, ulong asset2Id, double tolerance)
- 参数：
ulong asset1Id：要连接的资产之一的id。
ulong asset2Id：要连接的资产之一的id。
double tolerance：连接资产时允许的最大距离。 - 返回:
类型：bool
值：如果两个资产连接在一起，则为true。
JoinAssets() [2/2]（连接两个给定公差的资产。）
static bool JoinAssets (ulong asset1Id, ulong asset2Id, double tolerance, bool bIgnoreEqualDirection)
- 参数：
ulong asset1Id：要连接的资产之一的id。
ulong asset2Id：要连接的资产之一的id。
double tolerance：连接资产时允许的最大距离。
bool bIgnoreEqualDirection： - 返回:
类型：bool
值：如果两个资产连接在一起，则为true。
MoveAssets()（通过在组件中传递的转换去移动资产。）
static bool MoveAssets (ulong [] assetIds, Vector translation, Vector axis, float angle, Vector center, bool bShowProgress)
- 参数：
ulong [] assetIds：要移动的资产。
Vector translation：变换的平移部分。
Vector axis：变换的轴部分。
float angle：变换的角度部分。
Vector center：变换的中心部分。
bool bShowProgress：是否在移动资产的操作期间显示进度。 - 返回:
类型：bool
值：如果所有资产都成功移动，则为true。
RemoveDocument()（从资产中删除文档。）
static bool RemoveDocument (ulong assetId, string name)
- 参数：
ulong assetId：资产标识符。
string name：要删除的文档的名称。该名称区分大小写。 - 返回:
类型：bool
值：如果文档被删除，则为true。
RemoveScanImage()（删除扫描/区域资产的图像名称。）
static bool RemoveScanImage (ulong assetId, string fileName)
- 参数：
ulong assetId：资产标识符。
string fileName：图像文件的名称。 - 返回:
类型：bool
值：如果文件被删除，则为true。
SetAssetActive()（设置资产的属性值。）
static bool SetAssetActive (ulong assetId, bool isActive)
- 参数：
ulong assetId：资产的ID
bool isActive：指示资产是否处于活动状态的标志。 - 返回:
类型：bool
值：如果更改为true，则为false。、
SetAssetAppearance()（设置资产的外观。）
static bool SetAssetAppearance (ulong assetId, ulong appearanceId, bool childrenInherit)
- 参数：
ulong assetId：资产的ID。
ulong appearanceId：外观的ID
bool childrenInherit：是否要让所有的子类都继承外貌。 - 返回:
类型：bool
值：如果更改为true，否则为false。
SetAssetName()（设置资产的属性值。）
static bool SetAssetName (ulong assetId, string assetName)
- 参数：
ulong assetId：资产的ID。
string assetName：资产名称。 - 返回:
类型：bool
值：如果更改为true，否则为false。
SetAttachedObject()（设置附加到对象上的标记点。注：资产必须是一个标记点。）
static bool SetAttachedObject (ulong markedPointId, ulong objectAssetId, bool checkProximity)
- 参数：
ulong markedPointId：资产的ID，它必须是一个标记点。
ulong objectAssetId：对象的ID。设置为0重置基元。
bool checkProximity：是否检查标记点的边框是否落在基元的边框内。 - 返回:
类型：bool
值：如果更改为true，否则为false。
SetAttributeValue()（设置资产的属性值。）
static bool SetAttributeValue (ulong assetId, ulong attributeTemplateId, object attributeValue)
- 参数：
ulong assetId：资产的ID。
ulong attributeTemplateId：属性的ID。
object attributeValue：属性的新值。 - 返回:
类型：bool
值：如果更改为true，否则为false。
SetCatalog()（设置资产目录并找到最接近的匹配项。）
static bool SetCatalog (ulong assetId, ulong catalogItemId)
- 参数：
ulong assetId：资产的ID。
ulong catalogItemId：目录项的ID。 - 返回:
类型：bool
值：如果更改为true，否则为false。
SetCatalogInstance()（设置资产的目录实例。）
static bool SetCatalogInstance (ulong assetId, ulong catalogItemId, string catalogInstanceName)
- 参数：
ulong assetId：资产的ID。
ulong catalogItemId：目录项的ID。
string catalogInstanceName：目录中目录实例的名称。 - 返回:
类型：bool
值：如果更改为true，否则为false。
SetParent()（设置资产的父级。）
static bool SetParent (ulong assetId, ulong parentId, bool allowDuplicates, bool rename)
- 参数：
ulong assetId：资产的ID。
ulong parentId：新父节点的ID。
bool allowDuplicates：允许资产包含重复的共享。不赞成使用共享资产。
bool rename：如果发现重复项，是否重新命名新资产。 - 返回:
类型：bool
值：如果移动了为true，否则为false
SetPhysicalPropertyValue()（设置资产的属性值。）
static bool SetPhysicalPropertyValue (ulong assetId, string propertyName, object propertyValue)
- 参数：
ulong assetId：资产的ID。
string propertyName：要设置的属性的名称。
object propertyValue：属性的新值。 - 返回:
类型：bool
值：如果更改为true，否则为false。
SetProp()（按属性名设置属性值。）
static void SetProp (ulong asset, string propname, object propValue)
- 参数：
ulong asset：用于设置属性的资产。
string propertyName：属性名。
object propertyValue：属性值。
SetPropertyValue()（设置资产的属性值。）
static bool SetPropertyValue (ulong assetId, string propertyName, object propertyValue)
- 参数：
ulong assetId：资产的ID。
string propertyName：属性的名称。
object propertyValue：属性的新值。 - 返回:
类型：bool
值：如果更改为true，否则为false。
ShareAsset()（将一项资产共享父类）
static ulong ShareAsset (ulong assetId, ulong parentId, bool allowDuplicates)
- 参数：
ulong assetId：要共享的资产。
ulong parentId：共享的资产。
bool allowDuplicates：是否允许复制 - 返回:
类型：ulong
值：共享资产的ID。
Constants.BackgroundScene（为透视知识视图提供更多的背景场景类型）
属性
string Dawn 黎明
string Daylight 白天
string Desert 沙漠
string Dusk 黄昏
string Nighttime 夜间
string None 无
string Offshore 近海
BoundingBox（用于区段的脚本包装器）
属性
IVector Center 获取边框的中心点。
IVector Maximum 获取边框的最大值。
IVector Minimum 获取边框的最小值。
double Volume 包围框的体积
方法
BoundingBox()（默认构造函数）
BoundingBox (Vector min, Vector max)
- 参数：
Vector min：边框的最大值。
Vector max：边框的最小值。
Contains()（确定向量是否在边框内。）
bool Contains (Vector vector)
- 参数：
Vector vector：要检查的向量。 - 返回:
类型：bool
值：如果向量在方框内，则为true。
DropZ()（项目区段为Z = 0，因此它是一个矩形。）
void DropZ ()
Grow() [1/2]（在所有方向上增长一个指定距离的边界。）
void Grow (double distance)
- 参数：
double distance ：增长边界框的距离。
Grow() [2/2]（增长包围框以包含指定的包围框。）
void Grow (BoundingBox box)
- 参数：
BoundingBox box ：要与之相交的盒子。
Intersects()（确定两个边框是否相交。）
bool Intersects (BoundingBox box)
- 参数：
BoundingBox box ：要与之相交的盒子。 - 返回:
类型：bool
值：如果两个方框相交，则为true。
Constants.BoxProperties（框属性的名称）
属性
string Direction 方向
string Height 高度
string Length 长度
string Orientation 定向
string Position 方位
string Width 宽度
Constants.CameraDirection（知识视图的摄像机指示）
属性
string Down 向下
string East 东
string North 北
string NorthEast 东北
string NorthWest 西北
string South 南
string SouthEast 东南
string SouthWest 西南
string Up 上
string West 西
Constants.CameraType（用于知识视图的摄像机类型）
属性
string Orthographic 正交
string Perspective 透视
Catalog（实现各种静态目录API方法）
方法
GetCatalogInstanceNames()（获取目录项的目录实例名。）
static string [] GetCatalogInstanceNames (ulong catalogItem)
- 参数：
ulong catalogItem：目录项的ID。 - 返回:
类型：string []
值：目录实例的字符串数组。
GetCatalogInstancePropertyValues()（获取目录实例的属性值。）
static object [] GetCatalogInstancePropertyValues (ulong catalogItemId, string catalogInstanceName)
- 参数：
ulong catalogItemId：目录项的ID。
string catalogInstanceName：返回属性的实例的名称。 - 返回:
类型：object []
值：值的对象数组，如果没有目录项id，则为空对象数组。
GetCatalogItemPropertyNames()（获取目录项属性的名称。）
static string [] GetCatalogItemPropertyNames (ulong catalogItemId)
- 参数：
ulong catalogItemId：目录项的ID。 - 返回:
类型：string []
值：属性名的字符串数组，如果没有找到目录项，则为空数组。
GetCatalogItems()（获取目录的目录项。）
static ulong [] GetCatalogItems (ulong catalogId)
- 参数：
ulong catalogId ：目录的ID。 - 返回:
类型：ulong []
值：目录项id的数组。
Circle3d（执行圆操作的工具类）
属性
Vector Center 存储圆的中心
Orthonormal Orientation 存储圆的三维方向
double Radius 存储圆的半径
方法
Circle3d()（默认的构造函数）
Circle3d (Vector center, Orthonormal ori, double radius)
- 参数：
Vector center：圆的中心。
Orthonormal ori：圆的方向，其中z轴是与圆平面垂直的轴方向。
double radius：圆的半径。
GetOrientationAt()（获取圆周角上的点与圆心之间的方向。）
Vector GetOrientationAt (double angle)
- 参数：
double angle：方向必须返回的角度。 - 返回:
类型：Vector
值：圆角上的点与圆心夹角的方向。
GetPointAt() （在圆的角度中获取点）
Vector GetPointAt (double angle)
- 参数：
double angle：角度 - 返回:
类型：Vector
值：在圆的角度的点
GetTangentAt()（得到切线的角度。）
Vector GetTangentAt (double angle)
- 参数：
double angle：角度 - 返回:
类型：Vector
值：切线的角度
Constants.ConeProperties (圆锥的属性名称)
属性
string EndDiameter 末端直径
string EndDirection 末端方向
string EndPosition 末端位置
string Orientation 方向
string StartDiameter 首端直径
string StartDirection 首端方向
string StartPosition 首端位置
Constants.ConnectionType（连接资产的类型）
属性
string Inlet 入口
string Outlet 出口
Constants（常量的描述）
方法
Constants()（默认的构造函数）
Constants ()
Constants.CylinderProperties （气罐的属性名称）
属性
string Diameter 直径
string Direction 方向
string Length 长度
string Orientation 定位
string Position 位置
Database （实现各种静态数据的API方法）
方法
GetAppearance()（从数据中获取外观。）
static ulong GetAppearance (string appearanceName)
- 参数：
string appearanceName：外观的名称。 - 返回:
类型：ulong
值：外观id,如果没有找到则为0。
GetAppearanceIds()（未发布方法用于获取测试的所有外观的ID。）
static ulong [] GetAppearanceIds ()
- 参数：
string appearanceName：外观的名称。 - 返回:
类型：ulong []
值：外观的id
GetAssetTemplate()（从数据结构获取模板）
static ulong GetAssetTemplate (string templateName, string adapterName)
- 参数：
string templateName：模板的名称。
string adapterName：模板的适配器名称。 - 返回:
类型：ulong
值：模板id,如果没有找到则为0。
GetAttributeSetTemplate()（从数据结构中获取属性集模板）
static ulong GetAttributeSetTemplate (ulong template, string attributeSetName, string adapterName)
- 参数：
ulong template：父模板的ID。
string attributeSetName：属性集的名称。
string adapterName：属性集的适配器。 - 返回:
类型：ulong
值：数据集id,如果没有找到则为0。
GetAttributeTemplate()（从数据结构获取属性模板）
static ulong GetAttributeTemplate (ulong attributeSetTemplate, string attributeName)
- 参数：
ulong attributeSetTemplate：父属性集模板的ID。
string attributeName：属性名称。 - 返回:
类型：ulong
值：属性模板id,如果没有找到则为0。
GetCatalog()（根据目录名称获取目录。）
static ulong GetCatalog (string catalogName)
- 参数：
string catalogName：目录的名称。 - 返回:
类型：ulong
值：目录的ID(基于名称)，如果没有找到目录，则为0。
GetCatalogInstance()（获取具有指定名称的目录实例）
static ulong GetCatalogInstance (ulong catalogId, string catalogInstanceName)
- 参数：
ulong catalogId：目录项的ID。
string catalogInstanceName：目录实例的名称。 - 返回:
类型：ulong
值：目录实例的ID，如果没有找到则为0。
GetCatalogItem()（获取模板的目录）
static ulong GetCatalogItem (ulong templateId, string catalogName, string catalogItemName)
- 参数：
ulong templateId：模板的ID。
string catalogName：目录的名称。
string catalogItemName：目录项的名称。 - 返回:
类型：ulong
值：目录项的ID，如果没有找到则为0。
GetDataConnection()（从数据中获取外部数据连接。）
static ulong GetDataConnection (string connectionName)
- 参数：
string connectionName：数据连接的名称。 - 返回:
类型：ulong
值：数据连接的ID，如果没有找到则为0。
GetDisplayFilterIds()（方法获取所有显示筛选器的ID。用于测试。）
static ulong [] GetDisplayFilterIds ()
- 返回:
类型：ulong []
值：显示过滤器的工作空间id数组
GetKnowledgeViewIds()（获取所有知识视图的ID的未发布方法。用于测试。）
static ulong [] GetKnowledgeViewIds ()
- 返回:
类型：ulong []
值：知识视图的工作空间id数组。
GetSearchDefinition()（从数据库中获取搜索定义。）
static ulong GetSearchDefinition (ulong workspaceId, string searchName)
- 参数：
ulong workspaceId：搜索定义工作区的ID。
string searchName：搜索定义的名称。 - 返回:
类型：ulong
值：搜索定义的ID，如果没有找到则为0。
GetSearchDefinitionIds()（方法获取所有搜索定义的ID。用于测试。）
static ulong [] GetSearchDefinitionIds ()
- 返回:
类型：ulong []
值：搜索定义的工作空间id数组。
GetTemplateName()（获取模板的名称。）
static string GetTemplateName (ulong templateId)
- 参数：
ulong templateId：模板的ID。 - 返回:
类型：string
值：模板的名称
GetWorkspace()（从数据库中获取工作区）
static ulong GetWorkspace (string workspaceName)
- 参数：
string workspaceName：工作区名称。 - 返回:
类型：ulong
值：工作区的ID，如果没有找到则为0。
GetWorkspaceIds()（方法获取所有工作区的ID。用于测试。）
static ulong [] GetWorkspaceIds ()
- 返回:
类型：ulong []
值：作区的id数组。
IsTemplateTemporary()（验证从指定模板中实例化的资产是否为临时资产）
static bool IsTemplateTemporary (ulong templateId)
- 参数：
ulong templateId：模板的ID。 - 返回:
类型：bool
值：是临时则为true，否则false
IsWorkspace() （测试传递的Id是否属于工作区）
static bool IsWorkspace (ulong workspaceId)
- 参数：
ulong workspaceId：工作区的ID。 - 返回:
类型：bool
值：如果传递的Id对应于工作区则为true，否则为false。
UpdateCatalogFromXml()（从导出的目录XML文件更新现有目录的未发布方法。）
static bool UpdateCatalogFromXml (string xmlFileName)
- 参数：
string xmlFileName：xml文件的名称。 - 返回:
类型：bool
值：如果更新成功则为true，否则为false。
DataReader（实现GDA数据读取器类。）
属性
int RecordCount 数据行数。
方法
GetValue()（获取指定列的值。）
object GetValue (string columnName)
- 参数：
string columnName：必须返回值的列。 - 返回:
类型：object
值：指定列的值。
MoveNext()（将读取器移动到下一个数据行。）
bool MoveNext ()
- 返回:
类型：bool
值：成功返回true
Reset() （将当前行索引重置为表的开头。）
void Reset ()
Constants.DishProperties（盘属性名称）
属性
string Diameter 直径
string Direction 方向
string Height 高度
string Position 位置
DisplayFilters（实现静态API显示过滤器方法）
方法
CreateDisplayFilter()（在带有外观的工作区上创建具有指定名称的显示筛选器。）
static bool CreateDisplayFilter (string filterName, bool bPrivate, ulong parentId, ulong appearanceId, ulong [] assetIds)
- 参数：
string filterName：显示筛选器的名称。。
bool bPrivate：显示筛选器应该对用户是私有的还是公共的。。
ulong parentId：将创建筛选器的父文件夹或工作区的id。
ulong appearanceId：指定给显示筛选器的外观。
ulong [] assetIds：要添加到显示筛选器的资产的id。 - 返回:
类型：bool
值：如果成功创建显示筛选器则为True，否则为false。
CreateDisplayFilterFolder()（在父文件夹上创建具有指定名称的显示筛选器文件夹。）
static ulong CreateDisplayFilterFolder (string folderName, ulong parentId, bool isDuplicate)
- 参数：
string folderName：显示筛选器文件夹的名称。
ulong parentId：文件夹父级或工作区的ID。
bool isDuplicate：是否允许重复名称。 - 返回:
类型：ulong
值：创建文件夹的ID，如果没有创建文件夹则为0。
DeleteDisplayFilter()（删除具有指定id的显示筛选器 ）
static bool DeleteDisplayFilter (ulong filterId)
- 参数：
ulong filterId：要删除的筛选器。 - 返回:
类型：bool
值：如果显示过滤器被成功删除则为true，否则为false。
GetDisplayFilter()（获取父级上具有指定名称的显示筛选器。）
static ulong GetDisplayFilter (string filterName, ulong parentId)
- 参数：
string filterName：显示筛选器的名称。
ulong parentId：父级文件夹或工作区的Id。 - 返回:
类型：ulong
值：显示筛选器的ID。如果没有找到显示过滤器则返回0。
GetDisplayFilterAssets()（获取与显示筛选器关联的资产。）
static ulong [] GetDisplayFilterAssets (ulong filterId)
- 参数：
ulong filterId：显示筛选器的名称。 - 返回:
类型：ulong
值：筛选器中资产的id数组。如果筛选器无效，则为空列表。
GetDisplayFilterFolder()（获取指定父节点上具有指定名称的显示筛选器文件夹。）
static ulong GetDisplayFilterFolder (string folderName, ulong parentId)
- 参数：
string folderName：显示筛选器的名称。
ulong parentId：父级文件夹或工作区的Id。 - 返回:
类型：ulong
值：显示筛选器的ID。如果没有找到显示过滤器则返回0。
GetDisplayFilterName()（获取显示筛选器的名称。）
static string GetDisplayFilterName (ulong displayFilterId)
- 参数：
ulong displayFilterId ：显示筛选器Id。 - 返回:
类型：string
值：显示筛选器名称。如果不存在显示筛选器则为空。
UpdateDisplayFilter()（使用新资产更新具有指定id的显示筛选器。）
static bool UpdateDisplayFilter (ulong filterId, ulong [] assetIds)
- 参数：
ulong filterId ：要更新的筛选器。
ulong [] assetIds：要添加到显示筛选器的资产的id。 - 返回:
类型：bool
值：如果更新成功则为true，否则为false。
DisplayList （返回要显示的对象列表的实用程序类。）
方法
DisplayList()（默认构造函数）
DisplayList ()
Constants.DisplayStyle（显示的类型）
属性
string Hiddenline 虚线
string Solid 实线
string Wireframe 线框
Helpers（实现静态API帮助器方法）
方法
ClosestPointOnLine()（直线上最近的点）
static Vector ClosestPointOnLine (Vector point, Vector linePoint, Vector lineDirection)
- 参数：
Vector point ：点。
Vector linePoint：线点。
Vector lineDirection：线的方向。 - 返回:
类型：Vector
值：直线上最近的点
DegreesToRadians()（将指定的角度转换为弧度。）
static double DegreesToRadians (double angInDegrees)
- 参数：
double angInDegrees ：角度(以要转换的角度为单位)
GetMidPoint()（获取pos1和pos2之间的中点。）
static Vector GetMidPoint (Vector pos1, Vector pos2)
- 参数：
Vector pos1 ：第一个位置。
Vector pos2：第二个位置。 - 返回:
类型：Vector
值：pos1和pos2之间的中点。
RadiansToDegrees()（将指定的角度转换为弧度。）
static double RadiansToDegrees (double angInRadians)
- 参数：
double angInRadians ：要转换的弧度的角度。
Constants.IShapeProperties（I形状的属性名称）
方法
string CenterThickness 中心厚度
string Direction 方向
string EndThickness 结束点粗细
string Height 高度
string Length 长度
string Orientation 方向
string Position 位置
string Width 宽度
KeyValueMap（哈希表的实用程序类）
属性
bool AllowDuplicateValues 设置或获取开关，指示值列表是否可能包含重复值。此属性仅在值为列表时才有效。
int Count 返回哈希表中的键数。
方法
AddValue()（向map添加一个新值。）
bool AddValue (object key, object val)
- 参数：
object key ：键
object val：值 - 返回:
类型：bool
值：如果值被添加则为true;如果值已经存在则为false。
Clear()（清空map）
void Clear ()
GetKeyAt()（获取指定索引处的键。）
object GetKeyAt (int index)
- 参数：
int index：索引 - 返回:
类型：object
值：键
GetValue()（获取指定键的值。）
object GetValue (object key)
- 参数：
object key：键 - 返回:
类型：object
值：值
GetValueAt()（获取指定索引处的值。）
object GetValueAt ( int index )
- 参数：
int index：索引 - 返回:
类型：object
值：值
KnowledgeViews（为知识视图上的操作实现静态方法）
方法
AddAsset()（将资产添加到特定的知识视图。预览没有为视图更新。）
static bool AddAsset (ulong viewId, ulong assetId)
- 参数：
ulong viewId：向其中添加资产的知识视图的ID
ulong assetId：要添加到知识视图的资产的ID。 - 返回:
类型：bool
值：如果成功地将资产添加到视图中则为True。
AddFilter()（向特定的知识视图添加筛选器。预览没有为视图更新。）
static bool AddFilter (ulong viewId, ulong filterId)
- 参数：
ulong viewId：向其中添加资产的知识视图的ID
ulong filterId：要添加到知识视图的筛选器的ID。 - 返回:
类型：bool
值：如果成功地将筛选器添加到视图中则为True。
CreateKnowledgeView() [1/4]（在父视图上创建具有指定名称的知识视图。）
static ulong CreateKnowledgeView (string viewName, ulong parentId, string description, ulong [] assetIds, ulong [] displayFilterIds, BoundingBox boundingBox, string cameraDirection, string backgroundScene, bool isDuplicate, bool isPrivate)
- 参数：
string viewName：知识视图文件夹的名称。
ulong parentId：文件夹父级或工作区的ID
string description：知识视图的描述。
ulong [] assetIds：要包含在知识视图中的资产的id。
ulong [] displayFilterIds：要包含在知识视图中的显示筛选器的id。
BoundingBox boundingBox：视图的边界框用于放大/缩小知识视图。
string cameraDirection：知识视图的摄像方向，即北、南、东、西、上、下、东北、西北、东南、西南。
string backgroundScene：在知识视图中使用的背景场景类型，即日光、黄昏、黎明、沙漠、近海。
bool isDuplicate：是否允许重复名称。
bool isPrivate：知识视图对创建它的用户是否是私有的。 - 返回:
类型：ulong
值：创建的知识视图的ID，如果没有创建视图则为0。
CreateKnowledgeView() [2/4]（在父视图上创建具有指定名称的知识视图。）
static ulong CreateKnowledgeView (string viewName, ulong parentId, string description, ulong [] assetIds, ulong [] displayFilterIds, BoundingBox boundingBox, string cameraDirection, string backgroundScene, bool isDuplicate, bool isPrivate, bool showTags)
- 参数：
string viewName：知识视图文件夹的名称。
ulong parentId：文件夹父级或工作区的ID
string description：知识视图的描述。
ulong [] assetIds：要包含在知识视图中的资产的id。
ulong [] displayFilterIds：要包含在知识视图中的显示筛选器的id。
BoundingBox boundingBox：视图的边界框用于放大/缩小知识视图。
string cameraDirection：知识视图的摄像方向，即北、南、东、西、上、下、东北、西北、东南、西南。
string backgroundScene：在知识视图中使用的背景场景类型，即日光、黄昏、黎明、沙漠、近海。
bool isDuplicate：是否允许重复名称。
bool isPrivate：知识视图对创建它的用户是否是私有的。
bool showTags：是否显示标有知识点标记的知识视图。 - 返回:
类型：ulong
值：创建的知识视图的ID，如果没有创建视图则为0。
CreateKnowledgeView() [3/4]（在父视图上创建具有指定名称的知识视图。）
static ulong CreateKnowledgeView (string viewName, ulong parentId, string description, ulong [] assetIds, ulong [] displayFilterIds, BoundingBox boundingBox, string cameraType, string cameraDirection, string displayStyle, int backgroundColor, bool isDuplicate, bool isPrivate)
- 参数：
string viewName：知识视图文件夹的名称。
ulong parentId：文件夹父级或工作区的ID
string description：知识视图的描述。
ulong [] assetIds：要包含在知识视图中的资产的id。
ulong [] displayFilterIds：要包含在知识视图中的显示筛选器的id。
BoundingBox boundingBox：视图的边界框用于放大/缩小知识视图。
string cameraType：知识视图的摄像机类型，透视与正交其中之一。
string cameraDirection：知识视图的摄像方向，即北、南、东、西、上、下、东北、西北、东南、西南。
string displayStyle：知识视图中资产的显示样式，即实体、线框或隐藏线。
int backgroundColor：用于BGRA格式的知识视图的背景颜色。
bool isDuplicate：是否允许重复名称。
bool isPrivate：知识视图对创建它的用户是否是私有的。 - 返回:
类型：ulong
值：创建的知识视图的ID，如果没有创建视图则为0。
CreateKnowledgeView() [4/4]（在父视图上创建具有指定名称的知识视图。）
static ulong CreateKnowledgeView (string viewName, ulong parentId, string description, ulong [] assetIds, ulong [] displayFilterIds, BoundingBox boundingBox, string cameraType, string cameraDirection, string displayStyle, int backgroundColor, bool isDuplicate, bool isPrivate, bool showTags)
- 参数：
string viewName：知识视图文件夹的名称。
ulong parentId：文件夹父级或工作区的ID
string description：知识视图的描述。
ulong [] assetIds：要包含在知识视图中的资产的id。
ulong [] displayFilterIds：要包含在知识视图中的显示筛选器的id。
BoundingBox boundingBox：视图的边界框用于放大/缩小知识视图。
string cameraType：知识视图的摄像机类型，透视与正交其中之一。
string cameraDirection：知识视图的摄像方向，即北、南、东、西、上、下、东北、西北、东南、西南。
string displayStyle：知识视图中资产的显示样式，即实体、线框或隐藏线。
int backgroundColor：用于BGRA格式的知识视图的背景颜色。
bool isDuplicate：是否允许重复名称。
bool isPrivate：知识视图对创建它的用户是否是私有的。
bool showTags：是否显示标有知识点标记的知识视图。 - 返回:
类型：ulong
值：创建的知识视图的ID，如果没有创建视图则为0。
CreateKnowledgeViewFolder()（创建父目录上具有指定名称的知识视图文件夹。）
static ulong CreateKnowledgeViewFolder (string folderName, ulong parentId, bool isDuplicate)
- 参数：
string folderName：知识视图文件夹的名称。
ulong parentId：文件夹父级或工作区的ID
bool isDuplicate：是否允许重复名称。 - 返回:
类型：ulong
值：创建文件夹的ID，如果没有创建文件夹则为0。
CreateNonConsolidatedKnowledgeView()（创建一个已禁用资产整合的知识视图。）
static ulong CreateNonConsolidatedKnowledgeView (string viewName, ulong parentId, string description, ulong [] assetIds, ulong [] displayFilterIds, BoundingBox boundingBox, string cameraType, string cameraDirection, string displayStyle, int backgroundColor, bool isDuplicate, bool isPrivate, bool showTags)
- 参数：
string viewName：知识视图文件夹的名称。
ulong parentId：文件夹父级或工作区的ID
string description：知识视图的描述。
ulong [] assetIds：要包含在知识视图中的资产的id。
ulong [] displayFilterIds：要包含在知识视图中的显示筛选器的id。
BoundingBox boundingBox：视图的边界框用于放大/缩小知识视图。
string cameraType：知识视图的摄像机类型，透视与正交其中之一。
string cameraDirection：知识视图的摄像方向，即北、南、东、西、上、下、东北、西北、东南、西南。
string displayStyle：知识视图中资产的显示样式，即实体、线框或隐藏线。
int backgroundColor：用于BGRA格式的知识视图的背景颜色。
bool isDuplicate：是否允许重复名称。
bool isPrivate：知识视图对创建它的用户是否是私有的。
bool showTags：是否显示标有知识点标记的知识视图。 - 返回:
类型：ulong
值：创建的知识视图的ID，如果没有创建视图则为0。
GetAssets()（获取包含在知识视图中的所有资产。）
static ulong [] GetAssets (ulong viewId)
- 参数：
ulong viewId：视图id - 返回:
类型：ulong []
值：资产id数组，如果视图无效或没有任何资产则为空列表。
GetDisplayFilters()（获取知识视图中所有活动的显示筛选器。）
static ulong [] GetDisplayFilters (ulong viewId)
- 参数：
ulong viewId：视图id - 返回:
类型：ulong []
值：筛选器id数组，如果视图无效或没有任何活动筛选器则为空列表。
GetFolder()（获取指定父目录下具有指定名称的文件夹。）
static ulong GetFolder (string folderName, ulong parentId)
- 参数：
string folderName：要在父目录中查找的文件夹的名称。
ulong parentId：包含要查找的文件夹的父类文件夹。 - 返回:
类型：ulong
值：文件夹的ID。如果没有找到文件夹则为0。
GetName()（获取知识视图的名称。）
static string GetName (ulong viewId)
- 参数：
ulong viewId：视图id - 返回:
类型：string
值：视图的名称。如果视图无效则为空字符串。
GetParent()（获取指定的知识视图或文件夹所在的文件夹。）
static ulong GetParent (ulong viewId)
- 参数：
ulong viewId：视图id - 返回:
类型：ulong
值：文件夹的ID。如果没有找到文件夹则为零。
GetView()（获取在特定父级下具有指定名称的知识视图。）
static ulong GetView (string viewName, ulong parentId)
- 参数：
string viewName：要查找的视图的名称。
ulong parentId：视图所在的父视图。 - 返回:
类型：ulong
值：具有指定名称的视图的ID。如果没有找到视图则为零。
GetViews()（获取指定工作区中的所有知识视图。）
static ulong [] GetViews (ulong workspaceId)
- 参数：
ulong workspaceId：工作区域Id。 - 返回:
类型：ulong
值：指定工作区中的视图列表。
RemoveFilters()（从知识视图中移除所有过滤器。）
static bool RemoveFilters (ulong viewId)
- 参数：
ulong viewId：视图ID。 - 返回:
类型：bool
值：如果移除所有过滤器则为true。
SetAssets()（设置知识视图的资产。删除以前的资产。预览没有为视图更新。）
static bool SetAssets (ulong viewId, ulong [] assetIds)
- 参数：
ulong viewId：视图ID。
ulong [] assetIds：要设置到视图的资产id数组。 - 返回:
类型：bool
值：如果成功地将资产添加到知识视图则为true。
SetBackgroundColor()（设置知识视图的背景颜色。）
static bool SetBackgroundColor (ulong viewId, int backgroundColor)
- 参数：
ulong viewId：视图ID。
int backgroundColor：用于BGRA格式的知识视图背景颜色。 - 返回:
类型：bool
值：如果属性设置成功则为True，否则为false。
SetBackgroundScene()（设置知识视图的背景场景。）
static bool SetBackgroundScene (ulong viewId, string backgroundScene)
- 参数：
ulong viewId：视图ID。
int backgroundColor：用于BGRA格式的知识视图背景颜色。 - 返回:
类型：bool
值：如果属性设置成功则为True，否则为false。
SetBoundingBox()（设置知识视图的边框标志。）
static bool SetBoundingBox (ulong viewId, BoundingBox boundingBox)
- 参数：
ulong viewId：视图ID。
BoundingBox boundingBox：视图的边框用于放大/缩小知识视图。 - 返回:
类型：bool
值：如果属性设置成功则为true，否则为false。
SetCameraDirection()（设置知识视图的摄像机方向。）
static bool SetCameraDirection (ulong viewId, string cameraDirection)
- 参数：
ulong viewId：视图ID。
string cameraDirection：知识视图的摄像方向，即北、南、东、西、上、下、东北、西北、东南、西南。 - 返回:
类型：bool
值：如果属性设置成功则为true，否则为false。
SetCameraType()（设置知识视图的摄像机类型。）
static bool SetCameraType (ulong viewId, string cameraType)
- 参数：
ulong viewId：视图ID。
string cameraType：知识视图的摄像机类型，透视还是正交。 - 返回:
类型：bool
值：如果属性设置成功则为true，否则为false。
SetDescription()（设置知识视图的描述。）
static bool SetDescription (ulong viewId, string description)
- 参数：
ulong viewId：视图ID。
string cameraType：知识视图的描述。 - 返回:
类型：bool
值：如果属性设置成功则为true，否则为false。
SetDisplayStyle()（设置知识视图的显示样式。）
static bool SetDisplayStyle (ulong viewId, string displayStyle)
- 参数：
ulong viewId：视图ID。
string displayStyle：知识视图中资产的显示样式，即实线、线框或隐藏线。 - 返回:
类型：bool
值：如果属性设置成功则为true，否则为false。
SetName()（设置知识视图的名称。）
static bool SetName (ulong viewId, string name)
- 参数：
ulong viewId：视图ID。
string name：知识视图的名称。 - 返回:
类型：bool
值：如果名称设置成功则为true，否则为false。
SetParent()（设置知识视图的父视图。）
static bool SetParent (ulong viewId, ulong parentId, bool rename)
- 参数：
ulong viewId：视图ID。
ulong parentId：父视图id
bool rename：如果发现一个副本，是否重新命名新的知识视图。 - 返回:
类型：bool
值：如果设置成功则为true，否则为false。
SetShowTags()（设置知识视图的展示标签标志。）
static bool SetShowTags (ulong viewId, bool showTags)
- 参数：
ulong viewId：视图ID。
bool showTags：是否在知识视图中展示标签 - 返回:
类型：bool
值：如果成功设置展示标记则为true，否则为false。
SetShowTagsByTemplate()（通过模板设置知识视图的展示标签标志。）
static bool SetShowTagsByTemplate (ulong viewId, ulong [] templateIds)
- 参数：
ulong viewId：视图ID。
ulong [] templateIds：需要展示在知识视图的模板 - 返回:
类型：bool
值：如果成功设置展示标签则为true，否则为false。
Constants.LShapeProperties（形状属性的名称）
属性
string Direction 方向
string Height 高度
string Length 长度
string Orientation 定向
string Position 位置
string Thickness 厚度
string Width 宽度
Messages（实现静态API消息方法）
方法
SendMessage()（允许脚本向用户发送错误消息。）
static void SendMessage (string message)
- 参数：
string message：发送的消息
SendProgressMessage()（允许脚本向用户发送进度消息。）
static void SendProgressMessage (string message, int maximum, int val)
- 参数：
string message：发送的消息
nt maximum：最大进度值。最小值总是假设为0。
int val：当前进度值。
ObjectList（返回对象列表的实用程序类）
属性
ArrayList m_idList 在此对象列表中存储对象的ID。
ulong [] IDs 获取此对象列表中所有对象的ID。
方法
ObjectList()（默认构造函数）
ObjectList ()
Add()（将id添加到此对象列表。）
virtual int Add (ulong id)
- 参数：
ulong id：要添加到此对象列表的对象的ID。 - 返回:
类型：int
值：对象列表的新对象计数。
ObjectsPropertyList（对象，该对象由附加程序集宏返回。提供关于宏创建的资产和资产的放置选项的信息。）
方法
ObjectsPropertyList()（默认构造函数）
ObjectsPropertyList ()
Add()（将新创建资产的ID添加到此对象。）
override int Add (ulong id)
- 参数：
ulong id：要添加到此对象列表的对象的ID。 - 返回:
类型：int
值：对象列表的新对象计数。
AddObjectProperty()（为指定的资产添加放置选项。）
bool AddObjectProperty (ulong assetId, string propertyName, object propertyValue)
- 参数：
ulong assetId：必须为其添加配售选项的资产。
string propertyName：选项的属性名。
object propertyValue：选项的值。 - 返回:
类型：bool
值：如果放置选项被成功添加则为true，否则为false。
GetObjectProperties()（获取指定资产的配置选项。）
IAssetProperty [][] GetObjectProperties (ulong assetId)
- 参数：
ulong assetId：必须返回放置选项的资产。 - 返回:
类型：IAssetProperty [][]
值：一组放置选项。每个放置选项都是一个由一个或多个资产属性值组成的数组。
Orthonormal（用于标准正交(普通XYZ轴)的脚本包装器类）
方法
Orthonormal()（默认构造函数）
Orthonormal ()
GetXAxis()（获取标准法线x轴。）
IVector GetXAxis ()
- 返回:
类型：IVector
值：标准法线x轴。
GetYAxis()（获取标准法线y轴。）
IVector GetYAxis ( )
- 返回:
类型：IVector
值：标准法线y轴。
GetZAxis()（获取标准法线z轴。）
IVector GetZAxis ( )
- 返回:
类型：IVector
值：标准法线z轴。
Multiply()（复制指定向量。）
Vector Multiply (Vector position)
- 参数：
Vector position：要复制的向量。 - 返回:
类型：Vector
值：复制的向量
SetXAxis()（设置标准法线x轴。）
bool SetXAxis (Vector vector)
- 参数：
Vector vector：设置的向量。 - 返回:
类型：bool
值：如果设置成空则为true
SetYAxis()（设置标准法线y轴。）
bool SetYAxis (Vector vector)
- 参数：
Vector vector：设置的向量。 - 返回:
类型：bool
值：如果设置成空则为true
SetZAxis()（设置标准法线z轴。）
bool SetZAxis (Vector vector)
- 参数：
Vector vector：设置的向量。 - 返回:
类型：bool
值：如果设置成空则为true。
Permissions（实现静态API信息 方法）
方法
CanCreate()（验证当前用户是否可以创建指定资产类型的资产。）
static bool CanCreate (ulong assetTemplateId, ulong parentTemplateId, ulong workspaceId)
- 参数：
ulong assetTemplateId：要创建的资产模板。
ulong parentTemplateId：新资产的父类模板。
ulong workspaceId：将在其中创建资产的工作区。 - 返回:
类型：bool
值：如果可以创建资产则为true。
CanDelete()（验证当前用户是否可以删除指定资产类型的资产。）
static bool CanDelete (ulong assetTemplateId, ulong workspaceId)
- 参数：
ulong assetTemplateId：要删除的资产模板。
ulong workspaceId：要从其中删除资产的工作区。 - 返回:
类型：bool
值：如果资产可以删除则为true。
CanDeleteItem()（验证当前用户是否可以删除特定项。）
static int CanDeleteItem (ulong itemId)
- 参数：
ulong itemId：一个条目Id。 - 返回:
类型：int
值：1允许。-1没有范围。-2锁定(WIP锁定/独占锁定)
CanModify()（验证当前用户是否可以修改指定资产类型的资产。）
static bool CanModify (ulong assetTemplateId, ulong workspaceId)
- 参数：
ulong assetTemplateId：要修改的资产的模板。
ulong workspaceId：将在其中修改资产的工作区。 - 返回:
类型：bool
值：如果资产可能被修改，则为true。
CanModifyItem()（验证当前用户是否可以修改特定项。）
static int CanModifyItem (ulong itemId)
- 参数：
ulong itemId：一个条目Id。 - 返回:
类型：int
值：1允许。1没有范围。-2锁定(WIP锁定/独占锁定)
CanMove()（验证是否可以将资产模板的资产移动或共享到父类模板的资产中）
static bool CanMove (ulong assetTemplateId, ulong parentTemplateId, ulong workspaceId)
- 参数：
ulong assetTemplateId：要移动的资产的模板ID。
ulong parentTemplateId：模板标识新的父类。
ulong workspaceId：资产的工作区。 - 返回:
类型：bool
值：如果可以移动资产则为true，否则为false。
CanShare()（验证当前用户是否可以共享指定资产类型的资产。）
static bool CanShare (ulong assetTemplateId, ulong parentTemplateId, ulong workspaceId)
- 参数：
ulong assetTemplateId：要共享的资产的模板。
ulong parentTemplateId：新资产的父类的模板。
ulong workspaceId：要共享资产的工作区。 - 返回:
类型：bool
值：如果可以共享资产则为true，否则为false。
GetCurrentUserName()（获取登录到数据库的当前用户的名称。）
static string GetCurrentUserName ()
- 返回:
类型：string
值：包含当前用户名的字符串。
Primitives（用于基本操作的主类。）
方法
CopyPrimitives()（克隆基元 未发布方法。）
static ulong [] CopyPrimitives (ulong parentId, ulong [] primitiveIds)
- 参数：
ulong parentId：克隆体的父类
ulong [] primitiveIds：要克隆的基元ID。 - 返回:
类型：bool
值：如果可以共享资产则为true，否则为false。
CreatePrimitive()（创建一个新的基元。）
static ulong CreatePrimitive (ulong parentId, string primitiveTemplateName, string primitiveName)
- 参数：
ulong parentId：新基元的父元素。
string primitiveTemplateName ：新基元模板的名称。
string primitiveName：新基元的名称。 - 返回:
类型：bool
值：如果可以共享资产则为true，否则为false。
DeletePrimitive()（删除基元）
static bool DeletePrimitive (ulong primitiveId)
- 参数：
ulong primitiveId：要删除的基元的ID。 - 返回:
类型：bool
值：如果基元被成功删除则为true，否则为false。
DeletePrimitives()（删除基元）
static bool DeletePrimitives (ulong [] primitiveIds)
- 参数：
ulong [] primitiveIds：要删除的基元的ID数组。 - 返回:
类型：bool
值：如果基元被成功删除则为true，否则为false。
GetBoundingBox()（获取指定基元的边框。）
static BoundingBox GetBoundingBox (ulong primitive)
- 参数：
ulong primitive：必须为其返回边框的基元的ID。 - 返回:
类型：BoundingBox
值：边界框。
GetParent()（获取指定基元的父元素。）
static ulong GetParent (ulong primitive)
- 参数：
ulong primitive：必须返回父元素的基元ID。 - 返回:
类型：ulong
值：工作区中的基元父元素ID。
GetPhysicalSignature()（必须返回物理签名的基元ID。）
static int GetPhysicalSignature (ulong primitive)
- 参数：
ulong primitive：必须返回物理签名的基元ID。 - 返回:
类型：int
值：物理签名
GetPrimitivePropertyValue()（获取一个基元属性。）
static object GetPrimitivePropertyValue (ulong primitive, string propertyName)
- 参数：
ulong primitive：必须为其获取属性值的基元的ID。
string propertyName：要获取的属性的名称。 - 返回:
类型：object
值：属性的值。
GetPrimitiveTemplateNameOf()（获取指定基元的基元模板名称。）
static string GetPrimitiveTemplateNameOf (ulong primitive)
- 参数：
ulong primitive：必须返回模板名称的基元ID。 - 返回:
类型：string
值：模板名称或空字符串(如果无效)。
SetParent()（设置基元的父元素。）
static bool SetParent (ulong primitiveId, ulong parentId, bool rename)
- 参数：
ulong primitiveId：基元ID。
ulong parentId：新父节点的ID
bool rename：是否重命名 - 返回:
类型：bool
值：如果成功则为true，否则false。
SetPrimitivePropertyValue()（设置基本属性。）
static bool SetPrimitivePropertyValue (ulong primitive, string propertyName, object propertyValue)
- 参数：
ulong primitive：必须为其设置属性值的基元ID。
string propertyName：要更新的属性的名称。
object propertyValue：属性的新值。 - 返回:
类型：bool
值：如果设置成功则为true，否则false。
SplitExtrusion()（将挤出物分成单独的型材。）
static ulong [] SplitExtrusion (ulong primitiveId)
- 参数：
ulong primitiveId：将挤出的id分成单独的型材。 - 返回:
类型：ulong []
值：创建的新挤出物的数组。
ProjectPreferences（实现工程选项静态API 方法）
方法
GetScanCloudFilesLocation()（获取项目设置中扫描云文件的文件位置）
static string GetScanCloudFilesLocation ()
- 返回:
类型：string
值：扫描云文件的字符串
GetScanImageFilesLocation()（获取项目设置中扫描图像文件的文件位置）
static string GetScanImageFilesLocation ()
- 返回:
类型：string
值：扫描图像文件的字符串
Constants.PyramidProperties（棱锥属性名称）
属性
string EndDirection 末端方向
string EndHeight 末端高度
string EndPosition 末端位置
string EndWidth 末端宽度
string EndXDirection 末端横轴向
string StartDirection 首端方向
string StartHeight 首端高度
string StartPosition 首端位置
string StartWidth 首端宽度
string StartXDirection 首端横轴向
Search（实现搜索静态API方法）
方法
GetAssetsByName()
static ulong [] GetAssetsByName (string name, ulong template, ulong workspace)
- 参数：
string name：资产的名称。
ulong template：资产的模板。
ulong workspace：资产的工作区。 - 返回:
类型：ulong []
值：对象id数组。
GetAssetsBySearchDefinition()（根据搜索定义搜索资产。）
static ulong [] GetAssetsBySearchDefinition (ulong searchDefinition)
- 参数：
ulong searchDefinition：定义资产条件的搜索定义。 - 返回:
类型：ulong []
值：对象id数组，如果找不到资产则为空。
GetAssetsByTemplate()（通过模板搜索所有资产。）
static ulong [] GetAssetsByTemplate (ulong template, ulong workspace)
- 参数：
ulong template：资产的模板。
ulong workspace：资产的工作区。 - 返回:
类型：ulong []
值：对象id数组，如果找不到资产则为空。
GetAssetsByVicinity() [1/2]（通过邻近获取对象的资产和标记的点类型。）
static ulong [] GetAssetsByVicinity (BoundingBox boundingBox, ulong workspace)
- 参数：
BoundingBox boundingBox：要搜索的边框。
ulong workspace：资产的工作区。 - 返回:
类型：ulong []
值：指定工作区中边框内的对象id数组。
GetAssetsByVicinity() [2/2]（通过邻近获取资产。）
static ulong [] GetAssetsByVicinity (BoundingBox boundingBox, ulong [] templates, ulong workspace)
- 参数：
BoundingBox boundingBox：要搜索的边框。
ulong [] templates：要搜索的模板。
ulong workspace：资产的工作区。 - 返回:
类型：ulong []
值：指定工作区中边框内的对象id数组。
Constants.SphereProperties（球体属性名称）
属性
string Diameter 直径
string Position 位置
Constants.ToroidProperties（螺旋管属性的名称）
属性
string BendRadius 弯曲半径
string EndDirection 末端方向
string EndPosition 末端位置
string Height 高度
string StartDirection 首端方向
string StartPosition 首端位置
string Width 宽度
Constants.TorusProperties（环面属性的名称）
属性
string BendRadius 弯曲半径
string Diameter 直径
string EndDirection 末端方向
string EndPosition 末端位置
string StartDirection 首端方向
string StartPosition 首端位置
Constants.TShapeProperties（T形状属性的名称）
属性
string CenterThickness 中心厚度
string Direction 方向
string Height 高度
string Length 长度
string Orientation 方向
string Position 位置
string TopThickness 顶厚
string Width 宽度
Constants.TypeNames（资产或基本类型的名称）
属性
string Box 盒子
string Cone 圆锥体
string Cylinder 圆柱体
string Dish 碟
string Group 组
string IShape I形状
string Label 标签
string LShape L形状
string MarkedPoint 标记点
string Object 对象
string Pyramid 棱锥
string Sphere 球体
string Toroid 螺旋管
string Torus 环面
string TShape T形状
string UShape U形状
UserInterface（实现用户界面方法）
方法
GetDisplayedAssets()（获取当前查看器中显示的资产ID列表。）
static ulong [] GetDisplayedAssets ()
- 返回:
类型：ulong []
值：显示的资产ID的列表。
GetScreenPositionFrom3D()（获取当前查看器中3D位置的2D位置。）
static Vector GetScreenPositionFrom3D (Vector position3D)
- 返回:
类型：Vector
值：三维向量内部的二维位置。
HasViewerContext()（验证查看器上下文是否实例化。）
static bool HasViewerContext ()
- 返回:
类型：bool
值：如果有当前查看器则为true，否则为false。
UserPreferences（实现用户选项静态API方法）
方法
GetFileLocationsOverrideProject(获取用户首选项中扫描图像文件的文件位置)
static bool GetFileLocationsOverrideProject ()
- 返回:
类型：bool
值：扫描图像文件的字符串。
GetScanCloudFilesLocation()（获取用户首选项中扫描云文件的文件位置）
static string GetScanCloudFilesLocation ()
- 返回:
类型：string
值：扫描云文件的字符串
GetScanImageFilesLocation()（获取用户首选项中扫描图像文件的文件位置）
static string GetScanImageFilesLocation ()
- 返回:
类型：string
值：扫描图像文件的字符串
Constants.UShapeProperties（U形状的属性名称）
属性
string BaseThickness 基本轴向厚度
string Direction 方向
string Height 高度
string Length 长度
string Orientation 朝向
string Position 位置
string SideThickness 侧面厚度
string Width 宽度
Utilities（实现静态API集成方法）
方法
ExportScansToPCG()（导出点云的信息到pcg文件。）
static void ExportScansToPCG (string pcgLocation, ulong [] pointCloudIds)
- 参数：
string pcgLocation：要创建的pcg的路径和名称。
ulong [] pointCloudIds：要导出到pcg的点云id列表。
NewCircle3d()（构造一个新的Circle3d。）
static Circle3d NewCircle3d (Vector center, Orthonormal orientation, double radius)
- 参数：
string pcgLocation：要创建的pcg的路径和名称。
ulong [] pointCloudIds：要导出到pcg的点云id列表。 - 返回:
类型：Circle3d
值：一个Circle3d对象。
NewDataReader()（返回指定连接和SQL查询的数据读取器。）
static DataReader NewDataReader (ulong dataConnection, string sqlQuery)
- 参数：
ulong dataConnection：必须返回数据读取器的数据连接。
string sqlQuery：数据读取器返回的数据行的SQL查询。 - 返回:
类型：DataReader
值：一个数据阅读器。
NewDisplayList()（）
static DisplayList NewDisplayList ()
- 返回:
类型：DisplayList
值：一个新的程序集放置对象。
NewKeyValueMap()（获取一个新的空键值对。）
static KeyValueMap NewKeyValueMap (bool valueIsList)
- 参数：
bool valueIsList：指示值可以是列表。 - 返回:
类型：KeyValueMap
值：键值对。
NewObjectList()（初始化程序集放置对象。）
static ObjectList NewObjectList ()
- 返回:
类型：ObjectList
值：一个新的程序集放置对象。
NewObjectsPropertyList()（初始化程序集放置对象。）
static ObjectsPropertyList NewObjectsPropertyList ()
- 返回:
类型：ObjectsPropertyList
值：一个新的程序集放置对象。
NewOrthonormal()（初始化标准正交对象。）
static Orthonormal NewOrthonormal ()
- 返回:
类型：Orthonormal
值：一个新的标准正交对象。
NewVariableTable()（构造一个新的变量表。）
static VariableTable NewVariableTable ()
- 返回:
类型：VariableTable
值：新的变量表。
NewViewerList()（初始化观察者列表对象。）
static ViewerList NewViewerList ()
- 返回:
类型：ViewerList
值：新的观察者列表对象。
Vector（用于Db3dVector的脚本包装器。）
属性
int Accuracy 获取和设置向量精度，用于比较两个向量。
double Length 获取向量的长度(大小)。
double X 获取并设置向量X的值。
double Y 获取并设置向量Y的值。
double Z 获取并设置向量Z的值。
方法
Vector() [1/2]（默认构造函数）
Vector (double x, double y, double z)
- 参数：
double x：向量x的值。
double y：向量y的值。
double z：向量z的值。
Vector() [2/2]（默认构造函数）
Vector (string vector)
- 参数：
string vector 向量作为字符串。
Angle()（计算两个向量之间的夹角。）
double Angle (Vector direction)
- 参数：
Vector direction：用来计算角度的向量。 - 返回:
类型：double
值：这个向量和指定向量的夹角。
ApplyTransformation()（对向量进行变换。）
void ApplyTransformation (Vector translation, Vector axis, float angle, Vector center)
- 参数：
Vector translation：转化。
Vector axis：旋转轴。
float angle：旋转的角度。
Vector center：旋转的中心。
ConvertDirectionToSite()（将当前方向转换为数据库全局方向）
void ConvertDirectionToSite ()
ConvertPositionToSite()（将当前位置转换为数据库全局位置）
void ConvertPositionToSite ()
CrossProduct()（计算两个向量的外积。）
Vector CrossProduct (Vector direction)
- 参数：
Vector direction：用来计算外积的向量。 - 返回:
类型：Vector
值：这个向量和指定向量的叉乘。
DotProduct()（计算两个向量的点积。）
double DotProduct (Vector direction)
- 参数：
Vector direction：用来计算点积的向量。 - 返回:
类型：double
值：这个向量和指定向量的点积。
Equals()（比较是否相同）
override bool Equals (object obj)
- 参数：
object obj：要比较的向量。 - 返回:
类型：bool
值：如果相同返回true，否则false
GetDirectionString()（获取属性对话框中显示的字符串方向。）
string GetDirectionString ()
- 返回:
类型：string
值：个方向/方向为E/W, N/S, U/D的字符串。
GetDistance()（获取两个向量(位置)之间的距离。）
double GetDistance (Vector vector)
- 参数：
Vector vector：用来计算距离的向量。 - 返回:
类型：double
值：这个向量和指定向量之间的距离。
GetHashCode()（获取基于向量XYZ值的向量哈希码。）
override int GetHashCode ()
- 返回:
类型：int
值：哈希码表示向量X,Y,Z的值。
GetPositionString()（获取不包含单元的属性对话框中显示的字符串位置。）
string GetPositionString ()
- 返回:
类型：string
值：一个位置为E/W、N/S、U/D的字符串。
Normalize()（使这个向量规范化。）
void Normalize ()
operator!=()（不相等运算符。）
static bool operator!= (Vector vec1, Vector vec2)
- 参数：
Vector vec1：向量1
Vector vec2：向量2 - 返回:
类型：bool
值：如果向量不相等则为true，否则为false。
operator*() [1/2]（乘法运算符。）
static Vector operator* (Vector vector1, Vector vector2)
- 参数：
Vector vector1：向量1
Vector vector2：向量2 - 返回:
类型：Vector
值：特定向量的乘积。
operator*() [2/2]（乘法运算符。）
static Vector operator* (Vector vector1, double scale)
- 参数：
Vector vector1：向量1
double scale：范围1 - 返回:
类型：Vector
值：特定向量与比例尺的乘积。
operator+() [1/2]（加法运算符。）
static Vector operator+ (Vector vector1, Vector vector2)
- 参数：
Vector vector1：向量1
Vector vector2：向量2 - 返回:
类型：Vector
值：指定向量的和。
operator+() [2/2]（加法运算符。）
static Vector operator+ (Vector vector1, double scale)
- 参数：
Vector vector1：向量1
double scale：范围1 - 返回:
类型：Vector
值：指定向量和比例尺的和。
operator-()（减法运算符。）
static Vector operator- (Vector vector1, Vector vector2)
- 参数：
Vector vector1：向量1
Vector vector2：向量2 - 返回:
类型：Vector
值：特定向量的相减。
operator/()（除法操作符。）
static Vector operator/ (Vector vector1, double scale)
- 参数：
Vector vector1：向量1
double scale：范围1 - 返回:
类型：Vector
值：指定向量与比例尺的除法。
operator==()（相等操作符。）
static bool operator== (Vector vec1, Vector vec2)
- 参数：
Vector vec1：向量1
Vector vec2：向量2 - 返回:
类型：Vector
值：如果向量相等则为true，否则为false
Rotate()（旋转这个向量。）
Vector Rotate (double angle, Vector axis)
- 参数：
double angle：旋转的角度。
Vector axis：旋转这个向量的向量。 - 返回:
类型：Rotate
值：旋转向量。
ViewerList（返回对象列表的实用程序类）
属性
List m_idDisplayList 存储要显示的对象的ID。
List m_idHideList 存储要隐藏对象的ID
ulong [] DisplayList 获取显示列表中所有对象的ID。
ulong [] HideList 获取隐藏列表中所有对象的ID。
方法
ViewerList()（默认构造函数。）
ViewerList ()
Display() [1/2]（将id添加到此显示列表。）
int Display (ulong id)
- 参数：
ulong id：要添加到显示列表中的对象的ID。 - 返回:
类型：int
值：对象列表的新对象计数。
Display() [2/2]（将id添加到此显示列表。）
int Display (ulong [] ids)
- 参数：
ulong [] ids：要添加到显示列表中的对象的ID。 - 返回:
类型：int
值：对象列表的新对象计数。
Hide() [1/2]（将id添加到此隐藏列表。）
int Hide (ulong id)
- 参数：
ulong id：要添加到隐藏列表的对象的ID。 - 返回:
类型：int
值：对象列表的新对象计数。
Hide() [2/2]（将id添加到此隐藏列表。）
int Hide (ulong [] ids)
- 参数：
ulong [] ids：要添加到隐藏列表的对象的ID。 - 返回:
类型：int
值：对象列表的新对象计数。
Vnf（用于VNF操作的API类）
方法
CloneAttributeSet()（将临时VNF模板的属性克隆到数据库模板。）
bool CloneAttributeSet (string vnfNamespace, string typeOrAlias, string setName, ulong templateId, string[] excludeList)
- 参数：
string vnfNamespace：一个VNF命名空间过滤器。
string typeOrAlias：资产类型或其别名。
string setName：设置VNF类型的属性名以获取属性。
ulong templateId：添加属性的数据库模板。
string[] excludeList：要从克隆中排除的属性名称的可选列表。 - 返回:
类型：bool
值：如果创建了属性集和属性，则为True。
GetAssetPrimitiveData()（获取指定资产的原始数据。）
PrimitiveData [] GetAssetPrimitiveData (ulong attachedAssetId)
- 参数：
ulong attachedAssetId：附加资产的ID。 - 返回:
类型：PrimitiveData []
值：附加资产的原始数据数组。
GetAssetsByAttributeValue()（获取属性为‘attributeName’等于‘attributeValue’的资产。）
ulong [] GetAssetsByAttributeValue (string setName, string attributeName, string attributeValue, ulong[] filterByAssetIDs)
- 参数：
string setName：属性集名称。
string attributeName：属性名称。
string attributeValue：属性值(支持通配符*)。
ulong[] filterByAssetIDs：用作预过滤器的可选资产id列表。 - 返回:
类型：ulong []
值：发现的资产id列表。
GetAssetsByName()（获取具有指定名称的资产。）
ulong [] GetAssetsByName (string name, ulong[] filterByAssetIDs)
- 参数：
string name：要搜索的资产名称(支持通配符“*”)。
ulong[] filterByAssetIDs：用作预过滤器的可选资产id列表。 - 返回:
类型：ulong []
值：发现的资产id列表。
GetAssetsByType()（获取其VNF具有指定命名空间和其固有类型属性为“typeOrAlias”的资产。）
ulong [] GetAssetsByType (string vnfNamespace, string typeOrAlias, ulong[] filterByAssetIDs)
- 参数：
string vnfNamespace：一个VNF命名空间过滤器(详见备注)。
string typeOrAlias：资产类型或其别名。
ulong[] filterByAssetIDs：用作预过滤器的可选资产id列表。 - 返回:
类型：ulong []
值：发现的资产id列表。
GetAttributeMap()（获取指定附加资产和属性集的属性值。）
KeyValueMap GetAttributeMap (ulong id, string setName)
- 参数：
ulong id：附加资产的ID。
string setName：模板属性集的名称。 - 返回:
类型：KeyValueMap
值：带有属性名称和值的映射。
GetAttributeValue()（获取指定附加资产的属性值。）
object GetAttributeValue (ulong id, string setName, string attributeName)
- 参数：
ulong id：附加资产的ID。
string setName：模板属性集的名称。
string attributeName：模板属性的名称。 - 返回:
类型：object
值：检索到的属性值。
GetChildren()（获取指定的VNF文件或附加资源的子资源的id。）
ulong [] GetChildren (ulong id)
- 参数：
ulong id：VNF文件或附加资产的ID。 - 返回:
类型：ulong []
值：附加资产id的列表。
GetParent()（获取指定的VNF文件或附加资源的父资源的ID。）
ulong GetParent (ulong id)
- 参数：
ulong id：VNF文件或附加资产的ID。 - 返回:
类型：ulong
值：父VNF文件或附加资产的ID。
GetPrimitiveData()（获取指定资产的原始数据。）
PrimitiveData GetPrimitiveData (ulong primitiveId)
- 参数：
ulong primitiveId：附加原语的ID。 - 返回:
类型：PrimitiveData
值：附加原语的原语数据。
GetPrimitivePropertyValue()（获取一个原始属性。）
object GetPrimitivePropertyValue (ulong primitive, string propertyName)
- 参数：
ulong primitive：必须为其获取属性值的原语的ID。
string propertyName：要获取的属性的名称。 - 返回:
类型：object
值：原始属性的值。
GetPrimitives()（获取附加的VNF资产的指定资产的原始id。）
ulong [] GetPrimitives (ulong attachedAssetId)
- 参数：
ulong attachedAssetId：附加资产的ID。 - 返回:
类型：ulong []
值：附加原语id的数组。
GetPrimitiveTemplateNameOf()（获取附加资产的原语的指定原语id的模板名称。）
string GetPrimitiveTemplateNameOf (ulong primitiveId)
- 参数：
ulong primitiveId：附加原语的ID。 - 返回:
类型：string
值：原语模板的字符串名称。
GetPropertyValue()（获取指定的VNF文件或附加资产的固有属性值。）
object GetPropertyValue (ulong id, string propertyName)
- 参数：
ulong id：VNF文件或附加资产的ID。
string propertyName：固有属性的名称。（对于VNF文件属性，使用预定义的常量。VnfFile属性 名。对于附加的资产属性，使用预定义的常量。VnfAsset属性名。） - 返回:
类型：int
值：检索到的属性值。
扫一扫
330
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
