HOOPS Exchange

https://docs.techsoft3d.com/hoops/exchange/
Admin
HOOPS Exchange is a CAD data translation and interoperability toolkit that allows developers to...
Tokens:5,769,743
Snippets:105,790
Trust Score:9.7
Update:9 months ago
Show doc for...
Tokens:
Raw
### Tutorials and Getting Started

Source: https://docs.techsoft3d.com/hoops/exchange/release_notes/hp-then/2015_sp1

Guides and tutorials for setting up the environment and performing basic operations with HOOPS Exchange.

```APIDOC
## HOOPS Exchange Tutorials

### Description
Provides step-by-step tutorials for C and C# programming, covering environment setup, file translation, CAD structure traversal, and viewer creation.

### Tutorials
#### C Tutorials
1. Set Up Your Environment
2. File-to-File Translation
3. Traverse CAD Structure
4. Write a CAD Viewer

#### C# Tutorials
1. Set Up Your Environment
2. File-to-File Translation
3. Traverse CAD Structure

## Getting Started

### Description
Guides for evaluating HOOPS Exchange, covering technical overviews, file formats, and supported platforms.
```

--------------------------------

### Tutorials

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/functions/A3DAsmProductOccurrenceGetCat

Guides and examples for getting started with HOOPS Exchange using C and C#.

```APIDOC
## Tutorials

### Description
Provides step-by-step tutorials for getting started with HOOPS Exchange using C and C# programming languages.

### C Tutorials
1.  **Set Up Your Environment**: Guide to setting up the development environment for C.
2.  **File-to-File Translation**: Tutorial on translating files from one format to another.
3.  **Traverse CAD Structure**: How to traverse the structure of CAD files.
4.  **Write a CAD Viewer**: Creating a basic CAD viewer application.

### C# Tutorials
1.  **Set Up Your Environment**: Guide to setting up the development environment for C#.
2.  **File-to-File Translation**: Tutorial on translating files from one format to another using C#.
3.  **Traverse CAD Structure**: How to traverse the structure of CAD files using C#.
```

--------------------------------

### C Tutorial: Set Up Environment

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/functions/A3DComputeOrthoHLROnRepresentationItems

Guides users through the initial setup process for the C development environment with HOOPS Exchange. This typically involves installing necessary libraries and configuring the build system. No specific inputs or outputs are detailed, but successful setup is a prerequisite for other tutorials.

```c
#include <HOOPS/kAPI.h>
#include <HOOPS/A3D_IO.h>
#include <stdio.h>

int main() {
    // Placeholder for environment setup code
    printf("HOOPS Exchange C environment setup successful!\n");
    return 0;
}
```

--------------------------------

### C Tutorial: Set Up Environment

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/enums/A3DETextureWrappingMode

Guides users through the initial setup process for the C development environment when working with HOOPS Exchange. This typically involves installing necessary SDKs and configuring build paths.

```c
/* C Tutorial: Set Up Your Environment */

// Include necessary headers
#include <stdio.h>
#include <stdlib.h>
#include "path/to/hoops_exchange.h"

int main() {
    // Initialize HOOPS Exchange
    A3DSDKResult status = A3DSDK_Init(NULL);
    if (status != A3D_SUCCESS) {
        fprintf(stderr, "Failed to initialize HOOPS Exchange: %d\n", status);
        return 1;
    }

    printf("HOOPS Exchange environment set up successfully.\n");

    // Clean up HOOPS Exchange
    A3DSDK_Terminate();

    return 0;
}
```

--------------------------------

### Environment Setup and Basic Operations

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/topics/a3d_pdf_layout_module

Guides on setting up the development environment and performing basic operations like initialization and simple load/export.

```APIDOC
## Environment Setup and Basic Operations

### Description
This section provides instructions for setting up your development environment and performing essential operations like initializing the HOOPS Exchange toolkit and executing simple file load and export tasks.

### C Tutorials
- **1. Set Up Your Environment**: Guide to setting up the C development environment.
- **2. File-to-File Translation**: Basic file translation.
- **4. Write a CAD Viewer**: Building a simple viewer application.

### C# Tutorials
- **1. Set Up Your Environment**: Guide to setting up the C# development environment.
- **2. File-to-File Translation**: Basic file translation in C#.

### Programming Guide - Fundamentals
- **Initializing HOOPS Exchange**: Steps to initialize the toolkit.
  - **Extending HOOPS Exchange**: Information on extending the toolkit's functionality.
- **Simple Load and Export**: Performing basic file loading and exporting operations.
- **PRC**: Working with the PRC (Product Representation Compact) format.
  - **Persistent ID’s**: Understanding and using persistent identifiers.
- **Building PRC**: Creating PRC files.
  - **Creating a Model File Entity and Exporting It to a Physical File**: Step-by-step export process.
  - **Creating PRC Entities**: Creating various PRC entity types.
  - **Creating Representation Item PRC Entities**: Creating representation items.
  - **Creating Topology PRC Entities**: Creating topological elements.
  - **Creating Geometry PRC Entities**: Creating geometric elements.
  - **Defining Root-Level Attributes for a PRC Entity**: Setting attributes for root entities.
  - **Deleting a PRC Tree**: Removing PRC data structures.
- **Using Progress Functions**: Implementing progress reporting for long operations.
```

--------------------------------

### HOOPS Exchange Tutorials

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/topics/a3d_markuplinkeditem

Guides for getting started with HOOPS Exchange, including C and C# tutorials for environment setup, file translation, and CAD structure traversal.

```APIDOC
## HOOPS Exchange Tutorials

### C Tutorials

1. **Set Up Your Environment**: Instructions for configuring your development environment for C.
2. **File-to-File Translation**: Learn how to perform file format translations.
3. **Traverse CAD Structure**: Understand how to navigate the structure of CAD files.
4. **Write a CAD Viewer**: Guidance on creating a basic CAD viewer.

### C# Tutorials

1. **Set Up Your Environment**: Instructions for configuring your development environment for C#.
2. **File-to-File Translation**: Learn how to perform file format translations using C#.
3. **Traverse CAD Structure**: Understand how to navigate the structure of CAD files with C#.
```

--------------------------------

### HOOPS Exchange Tutorials

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/functions/A3DRepresentationItemTranslateToPkParts

Guides for getting started with HOOPS Exchange using C++ and C#.

```APIDOC
## C Tutorials

### Description
Provides a step-by-step guide to setting up your environment, performing file-to-file translations, traversing CAD structures, and writing a CAD viewer using C++.

### Tutorials
- 1. Set Up Your Environment
- 2. File-to-File Translation
- 3. Traverse CAD Structure
- 4. Write a CAD Viewer

## C# Tutorials

### Description
Guides for setting up your environment, performing file-to-file translations, and traversing CAD structures using C#.

### Tutorials
- 1. Set Up Your Environment
- 2. File-to-File Translation
- 3. Traverse CAD Structure
```

--------------------------------

### C Tutorials

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/functions/A3DCrvCircleCreate

Guides for setting up the environment, performing file-to-file translations, traversing CAD structures, and writing CAD viewers using C.

```APIDOC
## C Tutorials

### 1. Set Up Your Environment

**Description**: Steps to set up your development environment for using HOOPS Exchange with C.

### 2. File-to-File Translation

**Description**: Learn how to perform file-to-file translations using the HOOPS Exchange C API.

### 3. Traverse CAD Structure

**Description**: Guide on traversing the CAD data structure using HOOPS Exchange with C.

### 4. Write a CAD Viewer

**Description**: Instructions for creating a CAD viewer application with HOOPS Exchange using C.
```

--------------------------------

### C# Tutorial: Set Up Environment

Source: https://docs.techsoft3d.com/hoops/exchange/release_notes/hp-then/2017_u2

This C# tutorial covers the setup process for the HOOPS Exchange SDK in a .NET environment. It details the necessary steps to configure the project and ensure all dependencies are met. The setup typically involves referencing the correct assemblies. No direct code input/output is shown, focusing on project configuration.

```csharp
using System;
using TechSoft.HOOPS.Exchange;

public class EnvironmentSetup
{
    public static void Main(string[] args)
    {
        Console.WriteLine("Setting up HOOPS Exchange environment in C#...");

        // Placeholder for HOOPS Exchange initialization
        // HOOPSExchangeLoader.Initialize(); 
        // OR
        // A3DAppInitializeData appInitData = new A3DAppInitializeData();
        // A3DStatus status = HOOPSExchangeLoader.A3DInitialize(appInitData);

        // if (status == A3DStatus.A3D_SUCCESS)
        // {
        //     Console.WriteLine("HOOPS Exchange initialized successfully.");
        // }
        // else
        // {
        //     Console.WriteLine("Failed to initialize HOOPS Exchange. Status: " + status);
        // }
        
        Console.WriteLine("Ensure HOOPS Exchange assemblies are referenced in your project.");
        Console.WriteLine("Setup complete (conceptual).");
    }
}
```

--------------------------------

### C# Tutorial: Set Up Environment

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/topics/a3d_structure_module

This tutorial covers the setup process for developing with HOOPS Exchange using C#. It includes environment configuration and initial setup steps.

```csharp
using HOOPS.Exchange;

public class SetupExample
{
    public static void Main(string[] args)
    {
        // Initialize HOOPS Exchange
        A3DStatus status = A3DSDK.A3DInitialize();
        if (status != A3DStatus.A3D_SUCCESS)
        {
            // Handle initialization error
            return;
        }

        // ... rest of your C# code ...

        A3DSDK.A3DTerminate();
    }
}
```

--------------------------------

### HOOPS Exchange for Parasolid Developers: Getting Started

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/structures/A3DMathFct3DNonLinearData

This guide is tailored for developers working with Parasolid, providing instructions on how to integrate and utilize HOOPS Exchange within their Parasolid-based applications. It covers initial setup and common workflows for leveraging HOOPS Exchange's capabilities with Parasolid data.

```text
# HOOPS Exchange for Parasolid Developers: Getting Started

This section provides guidance for developers who are using Parasolid and want to integrate HOOPS Exchange.

## Prerequisites

*   Parasolid SDK installed and configured.
*   HOOPS Exchange SDK installed.

## Initial Setup

1.  **Link Libraries:** Ensure your project is correctly linking against both the Parasolid and HOOPS Exchange libraries.
2.  **Initialize HOOPS Exchange:** Call the appropriate HOOPS Exchange initialization function.
3.  **Initialize Parasolid:** Initialize the Parasolid kernel.

## Common Workflows

*   **Loading Parasolid Data:** Use HOOPS Exchange to load Parasolid files (e.g., `.x_t`, `.x_b`).
*   **Translating to Other Formats:** Convert loaded Parasolid data into formats supported by HOOPS Exchange for viewing or further processing.
*   **Accessing Geometry:** Retrieve Parasolid geometry information via the HOOPS Exchange API.

```

--------------------------------

### C# Environment Setup Tutorial

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/structures/A3DCrvIntersectionData

This tutorial guides developers through the process of setting up their development environment for using the HOOPS Exchange C# API. It includes instructions on installing the SDK, configuring project references, and verifying the setup.

```csharp
// Placeholder for C# code snippet
// Actual setup involves project configuration and potentially dll/assembly references.
```

--------------------------------

### C# Tutorial: Set Up Environment

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/structures/A3DAsmPublicationLinkedItemData

This tutorial covers the setup process for developing with HOOPS Exchange using C#. It includes instructions on installing necessary libraries and configuring the project.

```csharp
using Techsoft3d.HOOPSExchange;

public class Setup {
    public static void Main(string[] args) {
        // Environment setup code here
        Console.WriteLine("Environment setup complete.");
    }
}
```

--------------------------------

### Managing Graphics Attributes

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/functions/A3DRiSetCreate

Code examples for creating, deleting, and getting graphics attributes, including cascaded attributes and inserting them into the model.

```cpp
// C++ example for managing graphics attributes
// A3DStatus status = A3DMiscCascadedAttributesCreate(NULL, &cascadedAttributes);
```

```csharp
// C# example for managing graphics attributes
// A3DStatus status = A3DMiscCascadedAttributesCreate(IntPtr.Zero, ref cascadedAttributes);
```

--------------------------------

### C Tutorial: Set Up Environment

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/functions/A3DTopoFaceGetShell

This snippet outlines the steps to set up the development environment for C tutorials using HOOPS Exchange. It typically involves installing the SDK and configuring build tools. No specific inputs or outputs are defined at this stage.

```text
1. Set Up Your Environment
```

--------------------------------

### HOOPS Exchange C Tutorials

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/functions/A3DGlobalGetPointer

A series of tutorials for C developers to get started with HOOPS Exchange, covering environment setup, file translation, and CAD structure traversal.

```APIDOC
## HOOPS Exchange C Tutorials

### Description
These tutorials guide C developers through setting up their environment, performing basic file-to-file translations, traversing CAD structures, and creating a CAD viewer using HOOPS Exchange.

### Tutorials
- **1. Set Up Your Environment**: Instructions for configuring your development environment.
- **2. File-to-File Translation**: Learn how to translate files between different CAD formats.
- **3. Traverse CAD Structure**: Understand how to navigate and access the hierarchical structure of CAD data.
- **4. Write a CAD Viewer**: Develop a basic CAD viewer application.
```

--------------------------------

### C# Tutorials

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/functions/A3DCrvCircleCreate

Guides for setting up the environment, performing file-to-file translations, and traversing CAD structures using C#.

```APIDOC
## C# Tutorials

### 1. Set Up Your Environment

**Description**: Steps to set up your development environment for using HOOPS Exchange with C#.

### 2. File-to-File Translation

**Description**: Learn how to perform file-to-file translations using the HOOPS Exchange C# API.

### 3. Traverse CAD Structure

**Description**: Guide on traversing the CAD data structure using HOOPS Exchange with C#.
```

--------------------------------

### Getting Tessellation using A3DMeshData

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/functions/A3DRiSetCreate

Specific code examples for retrieving tessellated mesh data from CAD models using the `A3DMeshData` structure in HOOPS Exchange.

```cpp
// C++ example for getting tessellation with A3DMeshData
// A3DMeshData meshData;
// A3DEntityGetTessellation(entity, &meshData);
```

```csharp
// C# example for getting tessellation with A3DMeshData
// A3DMeshData meshData = new A3DMeshData();
// A3DEntityGetTessellation(entity, ref meshData);
```

--------------------------------

### Programming Guide: Getting the Bounding Box

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/enums/EA3DLocatorCoordinatePlane

Example showing how to obtain the bounding box of a CAD model or specific entities using HOOPS Exchange. This is essential for scene management and calculations.

```c
#include "path/to/hoops_exchange.h"

// ... inside a function ...
A3DBox box;
// Calculate bounding box for the model or an entity
// ... then access box.m_min, box.m_max
```

--------------------------------

### C Tutorial: Set Up Environment

Source: https://docs.techsoft3d.com/hoops/exchange/api/c/structures/A3DRiCurveData

This snippet demonstrates the initial steps to set up your development environment for C programming with HOOPS Exchange. It typically involves including necessary headers and initializing the library. No specific inputs or outputs are defined, but successful execution is crucial for subsequent operations.

```c
#include <stdio.h>
#include "path/to/hoops_exchange.h"

int main() {
    // Initialize HOOPS Exchange
    A3DStatus status = A3DSDK_Initialize();
    if (status != kA3DStatus_Success) {
        fprintf(stderr, "Failed to initialize HOOPS Exchange.\n");
        return 1;
    }
    printf("HOOPS Exchange initialized successfully.\n");
    // ... rest of your C code ...
    A3DSDK_Terminate();
    return 0;
}
```
Tokens:
Raw