BIM VILLAGE

Version 2.5.1

API

Introduction:

BIM Beaver offers an extensive set of APIs, including COM API and .NET API (currently under development), allowing users to enhance the functionality of the software by adding their own custom functions. This user manual provides an overview of how to utilize these APIs to integrate your own functions into BIM Beaver.

COM API:

The COM API provided by BIM Beaver enables users to extend the software’s capabilities through custom functions. COM (Component Object Model) is a Microsoft technology that allows software components to communicate with each other. To utilize the COM API, follow these steps:

a. Registering the API:

Once BIM Beaver is executed, the COM API is automatically registered in your system. This registration process ensures that the COM API is accessible and can be utilized to extend the functionality of BIM Beaver through custom functions. Therefore, there is no need for manual registration of the COM API after launching the software. You can directly proceed with accessing and implementing your custom functions using the registered COM API.

b. Accessing and Implementing Functions:

Once the COM API is successfully registered, you can access and implement your custom functions in BIM Beaver. Refer to the “COM API reference” for detailed instructions on how to interact with the API and incorporate your own functions. This guide provides information on the available methods, parameters, and examples to help you get started.

.NET API (Under Development):

In addition to the COM API, BIM Beaver is also developing a .NET API to further enhance extensibility. The .NET API leverages the capabilities of the Microsoft .NET framework, enabling developers to create powerful custom functions for BIM Beaver. Please note that the .NET API is currently under development, and more information will be provided once it becomes available.

Adding Custom Functions:
Regardless of the API you choose, you can leverage these APIs to add your own functions to BIM Beaver. Custom functions allow you to tailor the software to your specific needs and streamline your workflows. The process of adding custom functions typically involves:

a. Defining Function Requirements:

Determine the specific functionality you want to add to BIM Beaver. Identify the inputs, outputs, and desired behavior of your custom function.

b. Implementing the Function:

Utilize the appropriate API (COM or .NET) to implement your custom function within BIM Beaver. Follow the guidelines and best practices outlined in the respective API usage guides.

c. Testing and Integration:

Thoroughly test your custom function to ensure it performs as intended and integrates seamlessly with BIM Beaver. Validate its functionality with real-world data and scenarios.

Note: It is recommended to regularly check for updates and new releases of BIM Beaver to stay informed about improvements, bug fixes, and new features related to the API.

Conclusion:

The BIM Beaver APIs (COM and .NET) empower users to extend the capabilities of the software by incorporating their own custom functions. By following the guidelines provided in this user manual and referring to the respective API usage guides, you can effectively integrate your custom functions into BIM Beaver, enhancing your overall experience and productivity.


© 2019 - 2022 BIM VILLAGE.