MODELING_COMMIT

Detailed Description

Macros

#define MODELING_COMMIT_NONE
 
#define MODELING_COMMIT_UPDATE
 
#define MODELING_COMMIT_CREATEMAP
 
#define MODELING_COMMIT_REFRESH
 
#define MODELING_COMMIT_TRINGONS
 
#define MODELING_COMMIT_RESTORE
 
#define MODELING_COMMIT_ADDUNDO
 
#define MODELING_COMMIT_QUADS
 
#define MODELING_COMMIT_NOVALIDATION
 
#define MODELING_COMMIT_QUADLIMIT
 
#define MODELING_COMMIT_NO_NGONS
 

Macro Definition Documentation

◆ MODELING_COMMIT_NONE

#define MODELING_COMMIT_NONE

No flags.

◆ MODELING_COMMIT_UPDATE

#define MODELING_COMMIT_UPDATE

This only applies if the committed object is the same as the original; it is possible to commit the changes to another (clone) object without having to re-init.

Commit updates its internal data so that further editing can be done without having to re-init the kernel.

◆ MODELING_COMMIT_CREATEMAP

#define MODELING_COMMIT_CREATEMAP

Creates a map where points are mapped from/to, accessible with Modeling::GetPointMap().

Note
Translation maps for tags etc. (TranslationMaps) are not affected. They are always generated when needed.

◆ MODELING_COMMIT_REFRESH

#define MODELING_COMMIT_REFRESH

Tell the kernel to throw away internal data and start fresh.

◆ MODELING_COMMIT_TRINGONS

#define MODELING_COMMIT_TRINGONS

For example, an easy way to triangulate would be to just fetch the polygon selection into the kernel (Modeling::GetNgon() and Modeling::SetNgon()), then commit with this flag.

Force the kernel to make all changed (dirty) N-gons into their polygons (triangulated).

◆ MODELING_COMMIT_RESTORE

#define MODELING_COMMIT_RESTORE

Use instead of MODELING_COMMIT_UPDATE for any changes that are required to be updated from the original state (e.g. for tags).

Force the kernel to keep a duplicate of the original object and then restore the data and tags on the next Commit() call.

◆ MODELING_COMMIT_ADDUNDO

#define MODELING_COMMIT_ADDUNDO

Commit will add the document undo when the object is about to be changed. It will also remove it, should the commit fail.

◆ MODELING_COMMIT_QUADS

#define MODELING_COMMIT_QUADS

Same as MODELING_COMMIT_TRINGONS except it will try to create quads.

◆ MODELING_COMMIT_NOVALIDATION

#define MODELING_COMMIT_NOVALIDATION

This flag prevents this call from happening. It is used by the Add Point tool to allow it to add a single point into a hole of an N-gon.
.

The Modeling::Commit() function in has a pre-processing call that checks if the N-gons are valid, otherwise it can lead to really bad (or failed) triangulation.

◆ MODELING_COMMIT_QUADLIMIT

#define MODELING_COMMIT_QUADLIMIT

Used by the Delete tool to specify that the minimum allowed points in an N-gon is 4. Anything lower is ignored (not created). Without this flag the limit is 3.

◆ MODELING_COMMIT_NO_NGONS

#define MODELING_COMMIT_NO_NGONS

A combination of MODELING_COMMIT_TRINGONS and MODELING_COMMIT_QUADS, so that no N-gons are created.