Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(react-components): Implements CadTreeView for nodes in a Cad model #4854

Open
wants to merge 24 commits into
base: master
Choose a base branch
from

Conversation

nilscognite
Copy link
Contributor

@nilscognite nilscognite commented Nov 7, 2024

Type of change

Refactor

Description 📝

How has this been tested? 🔍

This PR is based on code from C. Tannum. It integrates loading of the nodes in a tree from CDF.

  • CadTreeView: Is the react component
  • CadTreeProps: According properies
  • New property of the TreeView is showRoot. This is true by default.
  • Updated story book tests

In CadTreeProps I have removed the properties of TreeProps that is no meaning. Also I have added onLoaded.
onLoaded is called when node is loaded, but before is is added/inserted into the tree. Here you can set the default CheckBoxState and other initialization. Typically:


  onLoaded(node: CadTreeNode, parent?: CadTreeNode)
  {
    if (parent === undefined) {
      return;    // No parent if root
   }
   node.checkBoxState = parent.checkBoxState;
   if (node.checkBoxState == CheckBoxState.All) {
     // Set the node visible in the viewer
   }
  }

Some unitlity functions I have made:

forceNodeInTree(): Force a specific node in the tree. Use case was given by C. Tannum.
scrollToTreeIndex() and scrollToNode(): Utility function for scrolling

Test instructions ℹ️

I don't know how to test this in React-comp. Test it in Fusion directly?

Checklist ☑️

  • I am proud of this feature.
  • I have performed a self-review of my own code.
  • I have added PR type (Feat, Bug, Chore, Test, Docs, Style, Refactor) to the PR title.
  • I have manually tested this for different scenarios (different models, formats, devices, browsers).
  • I have commented my code in hard-to-understand areas.
  • I have made corresponding changes to the public documentation.
  • I have added unit and visuals tests to prove that my feature works to the best of my ability.
  • I have refactored the code for readability to the best of my ability.
  • I have checked that my changes do not introduce regressions in the public documentation.
  • I have outlined any known defects / lacking capabilities in the contents of this PR.
  • I have listed any remaining work that should follow this PR in the description or jira/miro/etc.
  • I have added TSDoc to any public facing changes.
  • I have added "developer documentation" in any package README.md that is related / applicable to this PR.
  • I have noted down and am currently tracking any technical debt introduced in this PR.
  • I have thoroughly thought about the architecture of this implementation.
  • I have asked peers to test this feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant