v2.36
|
|
Provides methods to work with a Renga project. This interface can be obtained from IApplication interface. To edit Renga project use IOperation class. More...
Public Member Functions | |
HRESULT | CreateOperation ([out, retval] IOperation **ppOperation) |
Creates an operation. | |
HRESULT | CreateOperationWithUndo ([in] GUID modelId, [out, retval] IOperation **ppOperation) |
Creates an operation with undo history. | |
HRESULT | ExportDrawingsToOpenXpsS ([in] SAFEARRAY(BSTR) drawingIds, [in] BSTR filePath, [in] VARIANT_BOOL overwrite, [out, retval] int *pResult) |
Exports the collection of drawings to the OpenXPS file format. | |
HRESULT | ExportDrawingsToPdf ([in] SAFEARRAY(GUID) drawingIds, [in] BSTR filePath, [in] VARIANT_BOOL overwrite, [out, retval] int *pResult) |
Exports the collection of drawings to the PDF file format. | |
HRESULT | ExportDrawingsToPdfS ([in] SAFEARRAY(BSTR) drawingIds, [in] BSTR filePath, [in] VARIANT_BOOL overwrite, [out, retval] int *pResult) |
Same as ExportDrawingsToPdf, but accepting GUID as a string. | |
HRESULT | ExportToCsv ([in] BSTR folderPath, [in] VARIANT_BOOL overwrite, [out, retval] int *pResult) |
Exports the project data to CSV format. This method creates several CSV files in the given folder. | |
HRESULT | ExportToIfc ([in] BSTR filePath, [in] VARIANT_BOOL overwrite, [out, retval] int *pResult) |
Exports the project to the IFC file format. | |
HRESULT | ExportToIfc2 ([in] BSTR filePath, [in] VARIANT_BOOL overwrite, [in] IIfcExportSettings *pIfcExportSettings, [out, retval] int *pResult) |
Exports the project to the IFC file format. | |
HRESULT | GetEntityNumberInTopic ([in] GUID entityId, [out, retval] int *pResult) |
Returns the number of the specified entity in it's Topic. | |
HRESULT | GetEntityNumberInTopicS ([in] BSTR entityId, [out, retval] int *pResult) |
Same as GetEntityNumberInTopic, but accepting GUID as a string. | |
HRESULT | GetUndoStack ([in] GUID modelId, [out, retval] IUndoStack **ppUndoStack) |
The undo stack of the model See IProject::CreateOperationWithUndo. | |
HRESULT | HasActiveOperation ([out, retval] VARIANT_BOOL *pResult) |
Indicates whether the project has active operation. | |
HRESULT | HasFile ([out, retval] VARIANT_BOOL *pResult) |
Indicates whether the project has ever been saved. | |
HRESULT | HasUnsavedChanges ([out, retval] VARIANT_BOOL *pResult) |
Indicates whether the project has unsaved changes. | |
HRESULT | ImportCategory ([in] GUID entityTypeId, [in] BSTR filePath, [out, retval] IEntity **ppResult) |
Import category from STDL file. | |
HRESULT | ImportCategoryS ([in] BSTR entityTypeId, [in] BSTR filePath, [out, retval] IEntity **ppResult) |
Same as ImportCategory, but accepting GUID as a string. | |
HRESULT | Save ([out, retval] int *pResult) |
Saves the project under its current filename. | |
HRESULT | SaveAs ([in] BSTR filePath, [in] enum ProjectType projectType, [in] VARIANT_BOOL overwrite, [out, retval] int *pResult) |
Saves the project under the given filename. | |
Properties | |
IEntityCollection | Assemblies [get] |
Assemblies. | |
IBeamStyleManager | BeamStyleManager [get] |
The beam style manager. | |
IEntityCollection | BeamStyles [get] |
Beam styles. | |
IBuildingInfo | BuildingInfo [get] |
The building information. | |
IColumnStyleManager | ColumnStyleManager [get] |
The column style manager. | |
IEntityCollection | ColumnStyles [get] |
Column styles. | |
IDataExporter | DataExporter [get] |
The data exporter. | |
IEntityCollection | DoorStyles [get] |
Door styles. | |
IDrawingCollection | Drawings [get] |
Returns the collection of all the drawings in the project. | |
IEntityCollection | Drawings2 [get] |
Returns the collection of all the drawings in the project as IEntity. | |
IEntityCollection | DuctAccessoryCategories [get] |
Duct accessory categories. | |
IEntityCollection | DuctAccessoryStyles [get] |
Duct accessory styles. | |
IEntityCollection | DuctFittingCategories [get] |
Duct fitting categories. | |
IEntityCollection | DuctFittingStyles [get] |
Duct fitting styles. | |
IEntityCollection | DuctStyles [get] |
Duct styles. | |
IEntityCollection | ElectricalCircuitLineStyles [get] |
Electrical circuit line styles. | |
IEntityCollection | ElectricalConductorStyles [get] |
Electrical conductor styles. | |
IEntityCollection | ElectricDistributionBoardCategories [get] |
Electric distribution board categories. | |
IEntityCollection | ElectricDistributionBoardStyles [get] |
Distribution board styles. | |
IEntityCollection | ElementStyles [get] |
Element styles. | |
IEntityCollection | EquipmentCategories [get] |
Equipment categories. | |
IEquipmentStyleManager | EquipmentStyleManager [get] |
IEntityCollection | EquipmentStyles [get] |
Equipment styles. | |
BSTR | FilePath [get] |
The path of a previously-saved project file, or an empty string for a never-saved project. | |
IEntityCollection | HoleStyles [get] |
Hole styles. | |
BSTR | JournalPath [get] |
The path of a journal file. | |
ILandPlotInfo | LandPlotInfo [get] |
The land plot information. | |
ILayeredMaterialManager | LayeredMaterialManager [get] |
The layered material manager. | |
IEntityCollection | LayeredMaterials [get] |
Layered materials. | |
IEntityCollection | LayoutStyles [get] |
Layout styles. | |
IEntityCollection | LightingFixtureCategories [get] |
Lighting fixture categories. | |
IEntityCollection | LightingFixtureStyles [get] |
Lighting fixture styles. | |
IMaterialManager | MaterialManager [get] |
The material manager. | |
IEntityCollection | Materials [get] |
Materials. | |
IEntityCollection | MechanicalEquipmentCategories [get] |
Mechanical equipment categories. | |
IEntityCollection | MechanicalEquipmentStyles [get] |
Mechanical equipment styles. | |
IModel | Model [get] |
The building model. | |
IEntityCollection | PageFormatStyles [get] |
Page form styles. | |
IEntityCollection | PipeAccessoryCategories [get] |
Pipe accessory categories. | |
IEntityCollection | PipeAccessoryStyles [get] |
Pipe accessory styles. | |
IEntityCollection | PipeFittingCategories [get] |
Pipe fitting categories. | |
IEntityCollection | PipeFittingStyles [get] |
Pipe fitting styles. | |
IEntityCollection | PipeStyles [get] |
Pipe styles. | |
IEntityCollection | PlateStyles [get] |
Plate styles. | |
IEntityCollection | PlumbingFixtureCategories [get] |
Plumbing fixture categories. | |
IPlumbingFixtureStyleManager | PlumbingFixtureStyleManager [get] |
The plumbing fixture style manager. | |
IEntityCollection | PlumbingFixtureStyles [get] |
Plumbing fixture styles. | |
IProfileDescriptionManager | ProfileDescriptionManager [get] |
The profile description manager. | |
IEntityCollection | Profiles [get] |
Profiles. | |
IProjectInfo | ProjectInfo [get] |
The project information. | |
ProjectType | ProjectType [get] |
Returns the project type. | |
IPropertyManager | PropertyManager [get] |
The property manager. | |
IEntityCollection | RebarStyles [get] |
Rebar styles. | |
IEntityCollection | ReinforcementGrades [get] |
Reinforcement grades. | |
IEntityCollection | ReinforcementStyles [get] |
Reinforcement styles. | |
IReinforcementUnitStyleManager | ReinforcementUnitStyleManager [get] |
The reinforcement unit style manager. | |
IEntityCollection | ReinforcementUnitStyles [get] |
Reinforcement unit styles. | |
ISystemStyleManager | SystemStyleManager [get] |
The system style manager. | |
IEntityCollection | SystemStyles [get] |
System styles. | |
IEntityCollection | Topics [get] |
Topics. | |
IEntityCollection | WindowStyles [get] |
Window styles. | |
IEntityCollection | WiringAccessoryCategories [get] |
Wiring accessory categories. | |
IEntityCollection | WiringAccessoryStyles [get] |
Wiring accessory styles. | |
Provides methods to work with a Renga project. This interface can be obtained from IApplication interface. To edit Renga project use IOperation class.
HRESULT CreateOperation | ( | [out, retval] IOperation ** | ppOperation | ) |
HRESULT CreateOperationWithUndo | ( | [in] GUID | modelId, |
[out, retval] IOperation ** | ppOperation ) |
Creates an operation with undo history.
Same as CreateOperation, but with Undo history
Each model (IModel) has associated undo history stack. For example Building model, Assembly model, Drawing model have different undo history stacks. Changes in one model may cause changes in another one but all the changeset will form one undo item and will belong to concrete undo stack. The plugin developer can control where this item will be placed. It should also be understood that the undo operation is disabled for project based Renga entities, e.g. styles, materials, etc. The undo operation is applicable only for model objects.
[in] | modelId | ID of the model that will own the undo history item. See IModel::Id. |
HRESULT ExportDrawingsToOpenXpsS | ( | [in] SAFEARRAY(BSTR) | drawingIds, |
[in] BSTR | filePath, | ||
[in] VARIANT_BOOL | overwrite, | ||
[out, retval] int * | pResult ) |
Exports the collection of drawings to the OpenXPS file format.
[in] | drawingIds | An array of identifiers of drawings to export. |
[in] | filePath | File path. |
[in] | overwrite | A flag that controls the behavior in the case the OXPS file with the same name already exists: VARIANT_TRUE to overwrite, VARIANT_FALSE to return a failure code. |
[out] | pResult | Operation result. |
HRESULT ExportDrawingsToPdf | ( | [in] SAFEARRAY(GUID) | drawingIds, |
[in] BSTR | filePath, | ||
[in] VARIANT_BOOL | overwrite, | ||
[out, retval] int * | pResult ) |
Exports the collection of drawings to the PDF file format.
[in] | drawingIds | An array of identifiers of drawings to export. |
[in] | filePath | File path. |
[in] | overwrite | A flag that controls the behavior in the case the PDF file with the same name already exists: VARIANT_TRUE to overwrite, VARIANT_FALSE to return a failure code. |
[out] | pResult | Operation result. |
HRESULT ExportToCsv | ( | [in] BSTR | folderPath, |
[in] VARIANT_BOOL | overwrite, | ||
[out, retval] int * | pResult ) |
Exports the project data to CSV format. This method creates several CSV files in the given folder.
[in] | folderPath | File path. |
[in] | overwrite | A flag that controls the behavior in the case one of the CSV file with the same name already exists: VARIANT_TRUE to overwrite, VARIANT_FALSE to return a failure code. |
[out] | pResult | Operation result. |
HRESULT ExportToIfc | ( | [in] BSTR | filePath, |
[in] VARIANT_BOOL | overwrite, | ||
[out, retval] int * | pResult ) |
Exports the project to the IFC file format.
[in] | filePath | File path. |
[in] | overwrite | A flag that controls the behavior in the case an IFC file with the same name already exists: VARIANT_TRUE to overwrite, VARIANT_FALSE to return a failure code. |
[out] | pResult | Operation result. |
HRESULT ExportToIfc2 | ( | [in] BSTR | filePath, |
[in] VARIANT_BOOL | overwrite, | ||
[in] IIfcExportSettings * | pIfcExportSettings, | ||
[out, retval] int * | pResult ) |
Exports the project to the IFC file format.
[in] | filePath | File path. |
[in] | overwrite | A flag that controls the behavior in the case an IFC file with the same name already exists: VARIANT_TRUE to overwrite, VARIANT_FALSE to return a failure code. |
[in] | pIfcExportSettings | The IFC export settings. |
[out] | pResult | Operation result. |
HRESULT HasActiveOperation | ( | [out, retval] VARIANT_BOOL * | pResult | ) |
Indicates whether the project has active operation.
If there is an active operation then the plugin can not start another one.
HRESULT HasFile | ( | [out, retval] VARIANT_BOOL * | pResult | ) |
Indicates whether the project has ever been saved.
Use this function to distinguish new projects from ones that have already been saved.
HRESULT HasUnsavedChanges | ( | [out, retval] VARIANT_BOOL * | pResult | ) |
Indicates whether the project has unsaved changes.
HRESULT ImportCategory | ( | [in] GUID | entityTypeId, |
[in] BSTR | filePath, | ||
[out, retval] IEntity ** | ppResult ) |
Import category from STDL file.
HRESULT ImportCategoryS | ( | [in] BSTR | entityTypeId, |
[in] BSTR | filePath, | ||
[out, retval] IEntity ** | ppResult ) |
Same as ImportCategory, but accepting GUID as a string.
HRESULT Save | ( | [out, retval] int * | pResult | ) |
Saves the project under its current filename.
If there is no project open or there is no current filename, no prompts are shown to user, and a non-zero value is returned.
HRESULT SaveAs | ( | [in] BSTR | filePath, |
[in] enum ProjectType | projectType, | ||
[in] VARIANT_BOOL | overwrite, | ||
[out, retval] int * | pResult ) |
Saves the project under the given filename.
[in] | filePath | The file name of the project. |
[in] | projectType | The file format to save the project in: either a template (*.rnt) or a project (*.rnp). |
[in] | overwrite | A flag that controls the behavior in the case the project file already exists: pass VARIANT_TRUE to overwrite or VARIANT_FALSE to return a failure code. |
[out] | pResult | Operation result. |
|
get |
Returns the collection of all the drawings in the project.
|
get |
Returns the collection of all the drawings in the project as IEntity.
|
get |
|
get |
The plumbing fixture style manager.
|
get |
The system style manager.