NDEVR
API Documentation
DXFTableWriteIterator

Converts objects into entities that can be placed within a DXF Entity Table. More...

Inheritance diagram for DXFTableWriteIterator:
[legend]
Collaboration diagram for DXFTableWriteIterator:
[legend]

Public Member Functions

ParseResult process (Model &model) final override
 Called for each model node during traversal.
ParseResult process (Model &model, Geometry &geo) final override
 Called for each geometry associated with a model.
Public Member Functions inherited from ModelIterator
 ModelIterator ()
 Default constructor.
 ModelIterator (Buffer< Model > models)
 Constructs an iterator initialized with multiple root models.
 ModelIterator (const Model &model)
 Constructs an iterator initialized with a single root model.
void addToStack (const Model &model)
 Adds a model to the internal traversal stack without starting iteration.
Model currentModel () const
 Returns the model currently at the top of the traversal stack.
void parseAll ()
 Parses all models currently on the internal stack and their descendants.
void parseAll (const Model &model)
 Parses the given model and all of its descendants.
void parseAllChildren (const Model &parent)
 Parses all children of the given parent model, but not the parent itself.
void parseAllModels (const Buffer< Model > &models)
 Parses all models in the given buffer and their descendants.
ParseResult parseNext ()
 Parses the next model on the stack, processing it and optionally its geometry and material.

Public Attributes

Dictionary< UUID, BlockDatablock_data
 Block definitions keyed by model UUID.
Dictionary< String, uint04block_names
 Block name to handle index mapping.
const bool flatten_model
 Whether to flatten model hierarchy into layers.
DynamicPointer< CADHandleManagerhandle_manager
 Manages handle-to-UUID mapping during writing.
Dictionary< String, LayerDatalayers
 Layer definitions discovered during iteration.
Dictionary< UUID, DXFMaterialmaterial_data
 Material definitions keyed by material UUID.
uint04 num_of_shapes = 0
 Total number of shapes to write.
const FactoryParametersparams
 The factory parameters for this export.
const bool write_materials
 Whether to write material definitions.
Buffer< CADWriteModifier * > write_modifiers
 Custom write modifiers that intercept specific entity types.
DXFWriterwriter
 The DXF writer used for output.
Public Attributes inherited from ModelIterator
bool depth_first = true
 Whether to traverse depth-first (true) or breadth-first (false).
std::function< bool(const Model &, const Geometry &)> geo_filter
 Optional filter predicate for geometry processing. Returns true to include.
bool is_recursive = true
 Whether to recurse into child models.
std::function< bool(const Model &, const Material &)> material_filter
 Optional filter predicate for material processing. Returns true to include.
std::function< bool(const Model &)> model_filter
 Optional filter predicate for model processing. Returns true to include.
bool post_process_model = false
 Whether to invoke postProcess() after a model's children have been parsed.
bool process_geometry = true
 Whether to invoke process() for each Geometry on a model.
bool process_material = false
 Whether to invoke process() for each Material on a model.
bool process_model = true
 Whether to invoke process() for the model itself.
bool use_unit = false
 Whether to apply unit conversions during processing.

Additional Inherited Members

Public Types inherited from ModelIterator
enum  ParseResult { e_continue_parsing , e_do_not_parse_children , e_finish_parsing }
 The result returned by process functions to control iteration flow. More...
Protected Member Functions inherited from ModelIterator
virtual void _parseAllModels ()
 Internal method that drives the main parsing loop over all stacked models.
Model popNextModel ()
 Pops and returns the next model from the traversal stack.
virtual ParseResult postProcess (Model &model)
 Called after all children of a model have been processed, when post_process_model is true.
virtual ParseResult process (Model &model, Material &mat)
 Called for each material associated with a model.
void removeFromPostProcessStack ()
 Removes the current model from the post-process stack.
Protected Attributes inherited from ModelIterator
uint04 m_forward_position = 0U
 Current forward index position used in breadth-first traversal.
Buffer< std::pair< Model, uint04 > > m_model_parent_stack
 Stack tracking parent models and their child indices for post-processing.
Buffer< Modelm_model_stack
 The stack of models pending traversal.

Detailed Description

Converts objects into entities that can be placed within a DXF Entity Table.


If flatten_model is false these entities will consist of nested Blocks.

Definition at line 32 of file DXFBlockWriter.h.

Member Function Documentation

◆ process() [1/2]

ParseResult DXFTableWriteIterator::process ( Model & model)
finaloverridevirtual

Called for each model node during traversal.


Override to add custom model logic.

Parameters
[in]modelThe model being processed.
Returns
A ParseResult controlling further traversal.

Reimplemented from ModelIterator.

◆ process() [2/2]

ParseResult DXFTableWriteIterator::process ( Model & model,
Geometry & geo )
finaloverridevirtual

Called for each geometry associated with a model.


Override to add custom geometry logic.

Parameters
[in]modelThe model that owns the geometry.
[in]geoThe geometry being processed.
Returns
A ParseResult controlling further traversal.

Reimplemented from ModelIterator.


The documentation for this class was generated from the following file: