Brain 3D Component UI

Brain 3D Component UI is a powerful and flexible React component for rendering 3D brain visualizations. This package provides an easy-to-use interface for integrating complex brain imaging data into your web applications.

Example: https://github.com/bytezpro/example-brain-animation

Features

• High-performance 3D rendering of brain structures
• Interactive controls for rotation, zoom, and pan
• Customizable color schemes and highlighting options
• Support for various brain atlas and parcellation schemes
• Easy integration with React applications

Installation

To install the package, run the following command:

npm install threejs-brain-animation
# or
yarn add threejs-brain-animation

Usage

Here's a basic example of how to use the Brain3D component:

import { Brain } from 'threejs-brain-animation';

const App = () => {
  <div
    style={{
      width: '100vw',
      height: '100vh',
      display: 'flex',
      justifyContent: 'center',
      alignItems: 'center',
    }}
  >
    <Brain style={{ width: '600px', height: '600px' }} />
  </div>;
};

export default App;

API

| Prop | Type | Default | Description | | ------ | ------ | ------- | -------------------------- | | width | number | 1000 | Width of the brain canvas | | height | number | 500 | Height of the brain canvas |

Development

1. Clone the repository
2. Install dependencies: npm install
3. Start development server: npm start
4. Build the library: npm run build

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Note: See demo for more details.

For more detailed usage instructions and API documentation, please refer to our documentation.

Requirements

• Node.js >= 14.15.5
• React >= 16.8.0

Contributing

We welcome contributions! Please see our Contributing Guide for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions, please file an issue on our GitHub issue tracker.

Acknowledgements

We would like to thank the neuroimaging community for their invaluable input and support in the development of this component.