ModelingCommandData Struct Reference

#include <operatingsystem.h>

Detailed Description

A helper object for SendModelingCommand().

Public Member Functions
	ModelingCommandData ()=default
	~ModelingCommandData ()

Public Attributes
BaseDocument *	doc
BaseObject *	op
BaseContainer *	bc
MODELINGCOMMANDMODE	mode
MODELINGCOMMANDFLAGS	flags
AtomArray *	arr
AtomArray *	result

Constructor & Destructor Documentation

ModelingCommandData()

ModelingCommandData ( )

default

Default constructor.

~ModelingCommandData()

~ModelingCommandData

(

)

Default destructor.

Member Data Documentation

doc

BaseDocument* doc

The document for the operation. Should be set if possible.

Note

Must be set for MCOMMAND_MAKEEDITABLE, MCOMMAND_CURRENTSTATETOOBJECT and MCOMMAND_SPLINE_PROJECT.

op

BaseObject* op

The input object. Use arr for multiple objects.

bc

BaseContainer* bc

The modeling command container. Optional to set extra options.

mode

MODELINGCOMMANDMODE mode

The modeling command mode: MODELINGCOMMANDMODE.

flags

MODELINGCOMMANDFLAGS flags

The modeling command flags: MODELINGCOMMANDFLAGS.

arr

AtomArray* arr

The input objects. If this is nullptr op is used. The contents of arr may be changed during the operation.
If SendModelingCommand() returns successfully, arr contains all the input objects that were changed, while result contains the array of newly created objects.

result

AtomArray* result

The resulting object array for commands that create new objects.

Note

Not used if MODELINGCOMMANDFLAGS::CREATEUNDO is set in flags.