Files
create/src/Mod/Fem/App/FemPostObject.pyi
2025-11-11 13:26:18 -05:00

48 lines
1.3 KiB
Python

# SPDX-License-Identifier: LGPL-2.1-or-later
from __future__ import annotations
from typing import TypeAlias
from Base.Metadata import export
from App.GeoFeature import GeoFeature
vtkDataSet: TypeAlias = object
@export(
Include="Mod/Fem/App/FemPostObject.h",
Namespace="Fem",
FatherNamespace="App",
FatherInclude="App/GeoFeaturePy.h",
)
class FemPostObject(GeoFeature):
"""
The FemPostObject class.
Author: Mario Passaglia (mpassaglia@cbc.uba.ar)
License: LGPL-2.1-or-later
"""
def writeVTK(self, file_name: str, /) -> None:
"""
Write data object to VTK file.
filename: str
File extension is automatically detected from data type.
"""
...
def getDataSet(self) -> vtkDataSet:
"""
Returns the current output dataset.
For normal filters this is equal to the objects Data property output.
However, a pipelines Data property could store multiple frames, and hence
Data can be of type vtkCompositeData, which is not a vtkDataset.
To simplify implementations this function always returns a vtkDataSet,
and for a pipeline it will be the dataset of the currently selected frame.
Note that the returned value could be None, if no data is set at all.
"""
...