Extract Three D Cut features - Please provide example

[Morpheus5828]

Hi,
On Catia V5, I ve got an other setting called 3D Cut in DMU Optimizer mode.
And with 3D Cut, i can maybe extract STL files and also extract bounding box (old issue already mentionned).

I wish to get these informations using ThreeDCuts from pycatia.smt_interfaces.three_d_cuts.
But I didn't find example to how to use it ...
I would like to have these information from eeach level CATProduct, CATPart and VCI but without passing in design mode. Because if i ve got more than 8000 piece in my CATIA Tree, change to design mode is gonna be overkill.
Can you give us an example please ?

Best regards

[evereux]

Your question here has me a little confused.

And with 3D Cut, i can maybe extract STL files and also extract bounding box (old issue already mentioned).

I've not tested it thoroughly but I suspect the exported ThreeDCuts will likely be a .CATPart containing a Sketch. Not a STL file but can be converted ofcourse.

I would like to have these information from each level CATProduct, CATPart and VCI but without passing in design mode. Because if i ve got more than 8000 piece in my CATIA Tree, change to design mode is gonna be overkill.

If you want detail information from a .CATPart you're going to need to put it into design mode? I'm sure DMU Sections are just approximations. Maybe that's good enough?

I'll not comment further as this is just complicating the issue and getting into levels of support out of scope for here.

Anyways, with regards to using ThreeDCuts I'm currently a bit lost as to it's usage. It's completely new to me. If you take a look at your CAA V5 Visual Basic Help file and search for DMU Optimizer Automation Objects it gives a couple of hints to get started.

This is what I came up with:

from pycatia import catia
from pycatia.product_structure_interfaces.product_document import ProductDocument
from pycatia.smt_interfaces.three_d_cuts import ThreeDCuts

application = catia()
product_document: ProductDocument = application.active_document
product = product_document.product

three_d_cuts = ThreeDCuts(product.get_technological_object('ThreeDCuts'))

I can't even get ThreeDCuts.three_d_cut_shape_name() to work (tried a few hacky things).

ThreeDCuts inherits from the Collection object but we can't cycle through the collection as I don't know what the child object is (no clue in the docs).

Going to have to think on this. In the meantime I would ask myself, is this the best way to do what you're trying to do? 😄

Maybe someone else has some insight?

[evereux]

I think you've maybe been looking in the wrong place?

This sample here returns the DMU sections I was expecting. The features of Section make more sense too.

from pycatia import catia
from pycatia.product_structure_interfaces.product_document import ProductDocument

application = catia()
product_document: ProductDocument = application.active_document
product = product_document.product

spa = product_document.spa_workbench()
sections = spa.sections

for section in sections:
    print(section)

[Morpheus5828]

In fact for my project i want to extract every values in "Origines" and "Dimensions" boxes.
I ve implemanted your code but with ThreeDCut object with doesn't have some getters function to have these values ...

[evereux]

extract every values in "Origines" and "Dimensions" boxes

Looking at the docs you can't do that, only define them,

I've managed to get something to work now I know which workbench. 😄

from pathlib import Path

from pycatia import catia
from pycatia.navigator_interfaces.groups import Groups
from pycatia.product_structure_interfaces.product_document import ProductDocument
from pycatia.smt_interfaces.three_d_cuts import ThreeDCuts

application = catia()
product_document: ProductDocument = application.active_document
product = product_document.product

groups = Groups(product.get_technological_object('Groups'))
group = groups.add_from_sel()
group.add_explicit(product)

three_d_cuts = ThreeDCuts(product.get_technological_object('ThreeDCuts'))

origin = (10, 0, 0)
dimensions = (30, 30, 30)
three_d_cuts.set_type(1)
three_d_cuts.set_box(origin[0], origin[1], origin[2], dimensions[0], dimensions[1], dimensions[2])

doc = three_d_cuts.compute_3d_cut(group)
doc.save_as(Path(r'C:\Users\evereux\cloud\pycatia\__archive__\issues\cgr_ouput', 'temp.cgr'))

[evereux]

Sorry! Forgot to mention I'd made some updates locally to pycatia to get it to work.

I'll push an update out in the next day or so.

[Morpheus5828]

ok i was asking myself why it doesn't work xD

[Morpheus5828]

yeah because when I call compute_3d_cut, you have to put two arguments
else you will have this message

ThreeDCuts.compute_3d_cut() missing 1 required positional argument: 'group_of_selected_products'

[evereux]

So in some of those methods the VBA API expects an "initialised" Document object that it returns.

But we don't need to do that with python so these methods needed to be updated.

Take a look at the change to three_d_cuts.py.

This is one of the two typical fixes needed to be done if something isn't working as expected.

[evereux]

btw 0.9.2 is released now

[Morpheus5828]

import os, sys
from pycatia import catia
from pycatia.smt_interfaces.three_d_cuts import ThreeDCuts
from pycatia.navigator_interfaces.groups import Groups
from pycatia.product_structure_interfaces.product import Product
from pycatia.product_structure_interfaces.product_document import ProductDocument



def display_features(
    application,
    part_objects,
    current_product: Product,
):
    child_products_collection = current_product.products

    if child_products_collection.count > 0:
        for i in range(1, child_products_collection.count + 1):
            child_item = child_products_collection.item(i)
            child_instance = Product(child_item.com_object)

            display_features(
                application,
                part_objects=part_objects,
                current_product=child_instance,
            )


        groups = Groups(current_product.get_technological_object('Groups'))
        group = groups.add_from_sel()
        group.add_explicit(current_product)

        three_d_cuts = ThreeDCuts(current_product.get_technological_object('ThreeDCuts'))

        origin = (10, 0, 0)
        dimensions = (30, 30, 30)
        three_d_cuts.set_type(1)
        three_d_cuts.set_box(origin[0], origin[1], origin[2], dimensions[0], dimensions[1], dimensions[2])

        doc = three_d_cuts.compute_3d_cut(group)
        print(dir(three_d_cuts))

caa = catia()
documents: ProductDocument = caa.active_document
product_document = ProductDocument(documents.com_object)
root_product = Product(product_document.product.com_object)

display_features(
    application=caa,
    part_objects=caa,
    current_product=root_product,
)

With this code, you will have:

['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__getstate__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__iter__', '__le__', '__len__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'application', 'child_object', 'com_object', 'compute_3d_cut', 'compute_3d_cut_with_reference', 'count', 'get_compute_3d_cut', 'get_compute_3d_cut_with_a_reference', 'get_item', 'get_item_by_index', 'get_item_by_name', 'get_item_names', 'items', 'logger', 'name', 'parent', 'release_check', 'set_box', 'set_matrix', 'set_on_borders', 'set_type', 'three_d_cut_shape_name', 'three_d_cuts']```


it s really strange that you don't have get_box function or position function no ?

[Morpheus5828]

According the documentation of set_box function, we do, self.three_d_cuts.SetBox() so call this function from vtkLegendBoxActor object.
and if we see the code of this module:

class vtkLegendBoxActor(vtkmodules.vtkRenderingCore.vtkActor2D):
    background_color:'getset_descriptor'
    background_opacity:'getset_descriptor'
    border:'getset_descriptor'
    box:'getset_descriptor'
    box_property:'getset_descriptor'
    entry_text_property:'getset_descriptor'
    lock_border:'getset_descriptor'
    number_of_entries:'getset_descriptor'
    padding:'getset_descriptor'
    scalar_visibility:'getset_descriptor'
    use_background:'getset_descriptor'
    def __init__(self, **properties:Any) -> None: ...
    def BorderOff(self) -> None: ...
    def BorderOn(self) -> None: ...
    def BoxOff(self) -> None: ...
    def BoxOn(self) -> None: ...
    def GetBackgroundColor(self) -> Tuple[float, float, float]: ...
    def GetBackgroundOpacity(self) -> float: ...
    def GetBackgroundOpacityMaxValue(self) -> float: ...
    def GetBackgroundOpacityMinValue(self) -> float: ...
    def GetBorder(self) -> int: ...
    def GetBox(self) -> int: ...
    def GetBoxProperty(self) -> 'vtkProperty2D': ...
    def GetEntryColor(self, i:int) -> Tuple[float, float, float]: ...
    def GetEntryIcon(self, i:int) -> 'vtkImageData': ...
    def GetEntryString(self, i:int) -> str: ...
    def GetEntrySymbol(self, i:int) -> 'vtkPolyData': ...
    def GetEntryTextProperty(self) -> 'vtkTextProperty': ...
    def GetLockBorder(self) -> int: ...
    def GetNumberOfEntries(self) -> int: ...
    def GetNumberOfGenerationsFromBase(self, type:str) -> int: ...
    @staticmethod
    def GetNumberOfGenerationsFromBaseType(type:str) -> int: ...
    def GetPadding(self) -> int: ...
    def GetPaddingMaxValue(self) -> int: ...
    def GetPaddingMinValue(self) -> int: ...
    def GetScalarVisibility(self) -> int: ...
    def GetUseBackground(self) -> int: ...
    def HasTranslucentPolygonalGeometry(self) -> int: ...
    def IsA(self, type:str) -> int: ...
    @staticmethod
    def IsTypeOf(type:str) -> int: ...
    def LockBorderOff(self) -> None: ...
    def LockBorderOn(self) -> None: ...
    def NewInstance(self) -> 'vtkLegendBoxActor': ...
    def ReleaseGraphicsResources(self, __a:'vtkWindow') -> None: ...
    def RenderOpaqueGeometry(self, viewport:'vtkViewport') -> int: ...
    def RenderOverlay(self, viewport:'vtkViewport') -> int: ...
    def RenderTranslucentPolygonalGeometry(self, __a:'vtkViewport') -> int: ...
    @staticmethod
    def SafeDownCast(o:'vtkObjectBase') -> 'vtkLegendBoxActor': ...
    def ScalarVisibilityOff(self) -> None: ...
    def ScalarVisibilityOn(self) -> None: ...
    @overload
    def SetBackgroundColor(self, _arg1:float, _arg2:float, _arg3:float) -> None: ...
    @overload
    def SetBackgroundColor(self, _arg:Sequence[float]) -> None: ...
    def SetBackgroundOpacity(self, _arg:float) -> None: ...
    def SetBorder(self, _arg:int) -> None: ...
    def SetBox(self, _arg:int) -> None: ...
    @overload
    def SetEntry(self, i:int, symbol:'vtkPolyData', string:str, color:MutableSequence[float]) -> None: ...
    @overload
    def SetEntry(self, i:int, symbol:'vtkImageData', string:str, color:MutableSequence[float]) -> None: ...
    @overload
    def SetEntry(self, i:int, symbol:'vtkPolyData', icon:'vtkImageData', string:str, color:MutableSequence[float]) -> None: ...
    @overload
    def SetEntryColor(self, i:int, color:MutableSequence[float]) -> None: ...
    @overload
    def SetEntryColor(self, i:int, r:float, g:float, b:float) -> None: ...
    def SetEntryIcon(self, i:int, icon:'vtkImageData') -> None: ...
    def SetEntryString(self, i:int, string:str) -> None: ...
    def SetEntrySymbol(self, i:int, symbol:'vtkPolyData') -> None: ...
    def SetEntryTextProperty(self, p:'vtkTextProperty') -> None: ...
    def SetLockBorder(self, _arg:int) -> None: ...
    def SetNumberOfEntries(self, num:int) -> None: ...
    def SetPadding(self, _arg:int) -> None: ...
    def SetScalarVisibility(self, _arg:int) -> None: ...
    def SetUseBackground(self, _arg:int) -> None: ...
    def ShallowCopy(self, prop:'vtkProp') -> None: ...
    def UseBackgroundOff(self) -> None: ...
    def UseBackgroundOn(self) -> None: ...

``` we have GetBox function

[evereux]

it s really strange that you don't have get_box function or position function no ?

No. The ThreeDCut feature is only persistent during it's creation, where you need to define set_box. You can not call up an existing ThreeDCut feature. You have to define it each time you use the tool. Since you define it you know it's dims.

This is consistent with the docs of CAA V5 Visual Basic Help. Please refer to them.

What has vtkLegendBoxActor got to do with anything? Never heard of it before and it seems related to some GUI tooling.