quentintournier40 / animationfreecad Goto Github PK

Animation workbench for FreeCAD

License: Apache License 2.0

Python 86.81% Batchfile 0.01% CSS 1.71% Shell 0.04% Makefile 0.03% HTML 3.68% TeX 2.58% JavaScript 0.53% Roff 0.03% Emacs Lisp 4.59%

mod freecad 3d freecad-workbench animation visual-scripting pyflow addons workbench

animationfreecad's Introduction

Presentation

The FreeCAD Animation workbench allows users to animate any object easily through visual scripting Nodes thanks to PyFlow.

Note: This module use a modified version of PyFlow.

Documentation for this workbench can be found at AnimationFreeCAD/docs/guide.

The project

We offer you a new way to create small animations on FreeCAD through visual scripting.

Installation

Manual Install

The FreeCAD Animation workbench is cross-platform.
Depending on your platform, you need to first find out the path of your default FreeCAD config directory.

Note: After you have located the default config directory you'll need to decide on how to download the workbench. There are 2 options: git or via zip file.

Windows

On windows, this is typically in C:/Program Files/FreeCD 0.19/Mod/

Linux

In your CLI type: /path/to/freecad --get-config UserAppData

MacOS

In your CLI type: /path/to/freecad --get-config UserAppData

Using `git`

(Important Note: you may have to run your CLI in Administrator mode if you are on Windows)

cd {Your FreeCAD installation folder}
mkdir Mod/ # if there is no Mod/ directory
git clone https://github.com/QuentinTournier40/AnimationFreeCAD.git

Downloading zip file

Navigate to your {Your FreeCAD installation folder}.
Create a Mod directory.
Unzip the project in the Mod folder

Note: Make sure that the unzipped folder has not generated a sub-folder that contains the contents of the unzipped folder

Example:
❌ AnimationFreeCAD/AnimationFreeCAD/{Files}
✅ AnimationFreeCAD/{Files}

Prerequisites

This workbench requires FreeCAD v0.19 or higher. There are also external dependencies. Install the following dependencies into the local Module directory {Your FreeCAD installation folder}/FreeCAD/Mod

Qt.Py-master
nine
blinker-master
docutils

You will find in the folder requirements the files of its libraries:
{Your FreeCAD installation folder}/FreeCAD/Mod/AnimationFreeCAD/requirements.
Simply copy them in the Mod folder of FreeCAD: {Your FreeCAD installation folder}/FreeCAD/Mod.

⚠️⚠️ Note for Windows users: After doing this you will need to run FreeCAD in administrator mode for the first time in order to properly load dependencies. ⚠️⚠️

Thanks

We'd like to thank:

Authors

@QuentinTournier40
@AndreasCottet
@AimFried
@nvacher

We are 4 students from the University of Pau and the Basque Country. We're working on a project to graduate from Computer Science.

LICENSE

This project is released under the Apache License (see LICENSE file).

animationfreecad's People

Contributors

Stargazers

Watchers

Forkers

luzpaz drericebert leonardoricky chennes avtonomys j8sr0230 andrewweiol borg-org

animationfreecad's Issues

FreeCAD colors switch dark when PyFlow start

Initial GUI:

When PyFlow is launched:

Show the FreeCAD model in the PyFlow GUI

Hi,
I think you should take a look at FreeCAD/FreeCAD#6808
You certainly can use this to show the FreeCAD model in the PyFlow GUI.

clapCinema.svg not detected with FreeCAD appImage

Hello,
I just installed AnimationFreeCAD wb through the Addon Manager.
The workbench seems fully functional, but FreeCAD is continuously reporting an error every time I open a new file:

File does not exist! /tmp/.mount_FreeCANocsaG/usr/Mod/AnimationFreeCAD/icons/clapCinema.svg

I am using the latest FreeCAD 0.21 weekly build for linux on KDE Neon OS, but the error is present also with the stable release 0.20.2

[code]
OS: KDE neon 5.26 (KDE/plasma)
Word size of FreeCAD: 64-bit
Version: 0.21.0.31850 (Git) AppImage
Build type: Release
Branch: master
Hash: d8d3bb8120ad139cf1eb2acf0be0ae6c297ac7f3
Python 3.10.9, Qt 5.15.6, Coin 4.0.0, Vtk 9.1.0, OCC 7.6.3
Locale: English/United States (en_US)
Installed mods:

Beltrami 1.0.8-alpha
Nodes 0.1.36
freecad.gears 1.0.0
FEMbyGEN 1.2.0
Render 2022.4.0
Assembly4 0.12.5
Movie 2022.12.20
Assembly3 0.11.4
Curves 0.6.6
MeshRemodel 1.8919.0
A2plus 0.4.60i
freecad-dynamics-workbench-master
CfdOF 1.21.4
Glass
lattice2 1.0.0
AnimationFreeCAD 1.0.0
fasteners 0.4.54
Plot 2022.4.17
ExplodedAssembly
[/code]

does'nt work in my FreeCAD 0.19 (14.02.2022 issue) on my Linux Mint 21 Vanessa

hi,

I've got an issue when i want tot try this workshop: it's claim that "nine" is missing but it's in the right folder under the name "nine-1.1.0"

So i tried by renaming it just "nine", it was'nt better.

What shoud i do ?

Here's what terminal return:

o module named 'nine'
Traceback (most recent call last):
File "", line 18, in Initialize
File "/usr/lib/python3/dist-packages/shiboken2/files.dir/shibokensupport/feature.py", line 142, in _import
return original_import(name, *args, **kwargs)
File "/home/clement/.FreeCAD/Mod/AnimationFreeCAD/pyflow_start.py", line 2, in
from PyFlow.App import PyFlow
File "/usr/lib/python3/dist-packages/shiboken2/files.dir/shibokensupport/feature.py", line 142, in _import
return original_import(name, *args, **kwargs)
File "/home/clement/.FreeCAD/Mod/AnimationFreeCAD/PyFlow/App.py", line 34, in
from PyFlow.Core.Common import currentProcessorTime
File "/usr/lib/python3/dist-packages/shiboken2/files.dir/shibokensupport/feature.py", line 142, in _import
return original_import(name, *args, **kwargs)
File "/home/clement/.FreeCAD/Mod/AnimationFreeCAD/PyFlow/Core/init.py", line 21, in
from PyFlow.Core.PinBase import PinBase
File "/usr/lib/python3/dist-packages/shiboken2/files.dir/shibokensupport/feature.py", line 142, in _import
return original_import(name, *args, **kwargs)
File "/home/clement/.FreeCAD/Mod/AnimationFreeCAD/PyFlow/Core/PinBase.py", line 21, in
from nine import str

Missing Python dependencies

For me I had to manually install nine and docutils, see #13 (comment)

A FreeCAD fork for PyFlow (since original project is abandoned)

Maybe it's worth thinking about a fork for PyFlow since it has been abandoned by the original devs wonderworks-software/PyFlow#106 ?