|
| | CSOModificator (const std::string &type="CSOModificator", int numInImages=0, int numOutImages=0) |
| | Standard constructor.
|
| | CSOGenerator (std::string type="CSOGenerator", int numInImg=0, int numOutImg=0) |
| | Constructor.
|
| std::string | getType () const |
| | Returns the type of the CSOGenerator.
|
| | CSOBaseModule (const std::string &type="CSOBaseModule", int numInImages=0, int numOutImages=0) |
| | Standard constructor.
|
| MLMetaProfilePtr & | getMetaProfile () const |
| | Returns the metaprofile for the base operator.
|
| const char * | getTypeNameFast () const |
| | Module (int numInputImages, int numOutputImages) |
| | ~Module () override |
| InputConnectorField * | getInputImageField (MLint i) const |
| | Returns the field representing input image i. i must be a valid index.
|
| OutputConnectorField * | getOutputImageField (MLint i=0) const |
| | Returns the field representing output image i. i must be a valid index.
|
| MLint | getNumInputImages () const |
| | Returns the number of input images of this module.
|
| MLint | getNumOutputImages () const |
| | Returns the number of output images of this module.
|
| PagedImage * | getOutputImage (MLint outputIndex=0) const |
| | Returns the output image outputIndex. The index needs to be in the range [0, getNumOutputImages()-1].
|
| InputConnectorField * | addInputImage (const char *name=nullptr) |
| OutputConnectorField * | addOutputImage (const char *name=nullptr) |
| PagedImage * | getInputImage (MLint inputIndex, bool getReal=false) const |
| PagedImage * | getUpdatedInputImage (MLint inputIndex, bool getReal=false) const |
| MLErrorCode | processAllPages (int outputIndex=-1, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr) |
| MLErrorCode | processAllPages (ProcessAllPagesHandler &handler, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr) |
| MLErrorCode | processMissingPages (int outputIndex=0, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr) |
| void | clearOutputImage (MLint i=0) |
| | Clears cached output image pages of output image i.
|
| MLint | getOutputImageInplace (MLint outputIndex=0) const |
| MLint | getBypass (MLint outputIndex=0) const |
| THREAD_SUPPORT | getThreadSupport () const |
| bool | areRecursiveHandleNotificationsPermitted () const |
| MLint | getHandleNotificationEntryCounter () const |
| PERMITTED_TYPES | getVoxelDataTypeSupport () const |
| bool | isSupportedVoxelDataType (MLDataType dt) const |
| virtual INPUT_HANDLE | handleInput (int, INPUT_STATE) const |
| INPUT_STATE | getInputState (MLint index) |
| INPUT_STATE | getUpdatedInputState (MLint index) |
| bool | isInputImageField (Field *field) const |
| void | touchOutputImageFields () const |
| | Touches all output image fields to indicate that the images have changed.
|
| virtual void | beginSaveFields () |
| virtual void | endSaveFields () |
| | FieldContainer () |
| | Constructor.
|
| | ~FieldContainer () override |
| | Destructor: Deletes all added fields.
|
| std::string | whoAmI (bool withInstanceName=true) const |
| Field * | addField (const char *name, const char *type, const char *value) |
| Field * | addField (Field *field) |
| | Adds a field, the ownership of the field is passed to the FieldContainer.
|
| BoolField * | addBool (const char *name) |
| | Creates a BoolField with name and adds it to the container. Default value is false.
|
| BoolField * | addBool (const char *name, bool value) |
| | Creates a BoolField with name and adds it to the container.
|
| IntField * | addInt (const char *name) |
| | Creates an IntField with name and adds it to the container. Default value is 0.
|
| IntField * | addInt (const char *name, MLint value) |
| | Creates an IntField with name and adds it to the container.
|
| EnumField * | addEnum (const char *name, const char *const *enumerationItemNames, MLint numEnumerationItems) |
| EnumField * | addEnum (const char *name, const std::vector< std::string > &enumerationItemNames) |
| template<typename EnumType> |
| TypedEnumField< EnumType > * | addEnum (const char *name, const EnumValues< EnumType > &values, EnumType initialValue) |
| FloatField * | addFloat (const char *name) |
| | Creates a FloatField with name and adds it to the container. Default value is 0.f.
|
| FloatField * | addFloat (const char *name, float value) |
| | Creates a FloatField with name and adds it to the container.
|
| ProgressField * | addProgress (const char *name) |
| | Creates a float ProgressField with name and adds it to the container. Default value is 0.f.
|
| ProgressField * | addProgress (const char *name, float value) |
| | Creates a float ProgressField with name and adds it to the container.
|
| DoubleField * | addDouble (const char *name) |
| | Creates a DoubleField with name and adds it to the container. Default value is 0.
|
| DoubleField * | addDouble (const char *name, double value) |
| | Creates a DoubleField with name and adds it to the container.
|
| StringField * | addString (const char *name) |
| | Creates a StringField with name and adds it to the container. Default value is empty string.
|
| StringField * | addString (const char *name, const std::string &value) |
| | Creates a StringField with name and adds it to the container.
|
| NotifyField * | addNotify (const char *name) |
| | Creates a NotifyField field with name and adds it to the container.
|
| TriggerField * | addTrigger (const char *name) |
| BaseField * | addBase (const char *name) |
| | Creates a Base field with name and adds it to the container. Default value is NULL.
|
| BaseField * | addBase (const char *name, Base *value) |
| | Creates a Base field with name and adds it to the container.
|
| BaseField * | addBase (const char *name, const RefCountedBasePtr &value) |
| | Creates a Base field with name and adds it to the container. Sets the value from intrusive pointer.
|
| template<typename T> |
| BaseField * | addBaseWithAllowedType (const char *name, T *value=nullptr) |
| | As above, but also sets the allowed type of the field.
|
| template<typename T> |
| BaseField * | addBaseWithAllowedType (const char *name, const ::boost::intrusive_ptr< T > &value) |
| | As above, but also sets the allowed type of the field.
|
| template<typename T> |
| TypedBaseField< T > * | addTypedBase (const char *name) |
| | Creates a TypedBaseField with name and adds it to the container. Default value is NULL.
|
| template<typename T> |
| TypedBaseField< T > * | addTypedBase (const char *name, T *value) |
| | Creates a TypedBaseField with name and adds it to the container.
|
| template<typename T> |
| TypedBaseField< T > * | addTypedBase (const char *name, const ::boost::intrusive_ptr< T > &value) |
| | Creates a TypedBaseField with name and adds it to the container. Sets the value from intrusive pointer.
|
| SoNodeField * | addSoNode (const char *name) |
| | Creates a SoNodeField with name and adds it to the container. Default value is NULL.
|
| SoNodeField * | addSoNode (const char *name, SoNode *value) |
| | Creates a SoNodeField with name and adds it to the container.
|
| PointerField * | addPointer (const char *name) |
| | Creates a PointerField with name and adds it to the container.
|
| Vector2Field * | addVector2 (const char *name) |
| | Creates a Vector2Field with name and adds it to the container.
|
| Vector2Field * | addVector2 (const char *name, const Vector2 &value) |
| | Creates a Vector2Field with name and adds it to the container.
|
| Vector2Field * | addVector2 (const char *name, double x, double y) |
| | Creates a Vector2Field with name and adds it to the container.
|
| Vector3Field * | addVector3 (const char *name) |
| | Creates a Vector3Field with name and adds it to the container.
|
| Vector3Field * | addVector3 (const char *name, const Vector3 &value) |
| | Creates a Vector3Field with name and adds it to the container.
|
| Vector3Field * | addVector3 (const char *name, double x, double y, double z) |
| | Creates a Vector3Field with name and adds it to the container.
|
| Vector4Field * | addVector4 (const char *name) |
| | Creates a Vector4Field with name and adds it to the container.
|
| Vector4Field * | addVector4 (const char *name, const Vector4 &value) |
| | Creates a Vector4Field with name and adds it to the container.
|
| Vector4Field * | addVector4 (const char *name, double x, double y, double z, double w) |
| | Creates a Vector4Field with name and adds it to the container.
|
| Vector5Field * | addVector5 (const char *name) |
| | Creates a Vector5Field with name and adds it to the container.
|
| Vector5Field * | addVector5 (const char *name, const Vector5 &value) |
| | Creates a Vector5Field with name and adds it to the container.
|
| Vector6Field * | addVector6 (const char *name) |
| | Creates a Vector6Field with name and adds it to the container.
|
| Vector6Field * | addVector6 (const char *name, const Vector6 &value) |
| | Creates a Vector6Field with name and adds it to the container.
|
| Vector10Field * | addVector10 (const char *name) |
| | Creates a Vector10Field with name and adds it to the container.
|
| Vector10Field * | addVector10 (const char *name, const Vector10 &value) |
| | Creates a Vector10Field with name and adds it to the container.
|
| ImageVectorField * | addImageVector (const char *name) |
| | Creates a ImageVectorField with name and adds it to the container.
|
| ImageVectorField * | addImageVector (const char *name, const ImageVector &value) |
| | Creates a ImageVectorField with name and adds it to the container.
|
| ImageVectorField * | addImageVector (const char *name, MLint x, MLint y, MLint z, MLint c, MLint t, MLint u) |
| | Creates a ImageVectorField with name and adds it to the container.
|
| SubImageBoxField * | addSubImageBox (const char *name) |
| | Creates a SubImageBoxField with name and adds it to the container.
|
| SubImageBoxField * | addSubImageBox (const char *name, const SubImageBox &value) |
| | Creates a SubImageBoxField with name and adds it to the container.
|
| SubImageBoxdField * | addSubImageBoxd (const char *name) |
| | Creates a SubImageBoxd field with name and adds it to the container.
|
| SubImageBoxdField * | addSubImageBoxd (const char *name, const SubImageBoxd &value) |
| | Creates a SubImageBoxd field with name and adds it to the container.
|
| ColorField * | addColor (const char *name) |
| | Creates a ColorField with name and adds it to the container.
|
| ColorField * | addColor (const char *name, float r, float g, float b) |
| | Creates a ColorField with name and adds it to the container.
|
| ColorField * | addColor (const char *name, const Vector3 &value) |
| | Creates a ColorField with name and adds it to the container.
|
| PlaneField * | addPlane (const char *name) |
| | Creates a PlaneField with name and adds it to the container.
|
| PlaneField * | addPlane (const char *name, double f0, double f1, double f2, double f3) |
| | Creates a PlaneField with name and adds it to the container.
|
| PlaneField * | addPlane (const char *name, const Plane &value) |
| | Creates a PlaneField with name and adds it to the container.
|
| RotationField * | addRotation (const char *name) |
| | Creates a RotationField with name and adds it to the container.
|
| RotationField * | addRotation (const char *name, const Rotation &value) |
| | Creates a RotationField with name and adds it to the container.
|
| Matrix2Field * | addMatrix2 (const char *name) |
| | Creates a Matrix2Field with name and adds it to the container.
|
| Matrix2Field * | addMatrix2 (const char *name, const Matrix2 &value) |
| | Creates a Matrix2Field with name and adds it to the container.
|
| Matrix3Field * | addMatrix3 (const char *name) |
| | Creates a Matrix3Field with name and adds it to the container.
|
| Matrix3Field * | addMatrix3 (const char *name, const Matrix3 &value) |
| | Creates a Matrix3Field with name and adds it to the container.
|
| Matrix4Field * | addMatrix4 (const char *name) |
| | Creates a Matrix4Field with name and adds it to the container.
|
| Matrix4Field * | addMatrix4 (const char *name, const Matrix4 &value) |
| | Creates a Matrix4Field with name and adds it to the container.
|
| Matrix5Field * | addMatrix5 (const char *name) |
| | Creates a Matrix5Field with name and adds it to the container.
|
| Matrix5Field * | addMatrix5 (const char *name, const Matrix5 &value) |
| | Creates a Matrix5Field with name and adds it to the container.
|
| Matrix6Field * | addMatrix6 (const char *name) |
| | Creates a Matrix6Field with name and adds it to the container.
|
| Matrix6Field * | addMatrix6 (const char *name, const Matrix6 &value) |
| | Creates a Matrix6Field with name and adds it to the container.
|
| MatrixField * | addMatrix (const char *name) |
| | Creates a MatrixField with name and adds it to the container.
|
| MatrixField * | addMatrix (const char *name, const Matrix4 &value) |
| | Creates a MatrixField with name and adds it to the container.
|
| MLDataTypeField * | addMLDataType (const char *name) |
| | Creates a MTDataTypeField with name and adds it to the container.
|
| MLDataTypeField * | addMLDataType (const char *name, MLDataType value) |
| | Creates a MTDataTypeField with name and adds it to the container.
|
| UniversalTypeField * | addUniversalType (const char *name) |
| | Creates an UniversalTypeField field with name and adds it to the container.
|
| IntListField * | addIntList (const char *name) |
| | Creates an IntListField field with name and empty list value and adds it to the container.
|
| IntListField * | addIntList (const char *name, const std::vector< MLint > &value) |
| | Creates an IntListField field with name and given list value and adds it to the container.
|
| DoubleListField * | addDoubleList (const char *name) |
| | Creates an DoubleListField field with name and empty list value and adds it to the container.
|
| DoubleListField * | addDoubleList (const char *name, const std::vector< double > &value) |
| | Creates an DoubleListField field with name and given list value and adds it to the container.
|
| Vector2ListField * | addVector2List (const char *name) |
| | Creates an Vector2ListField field with name and empty list value and adds it to the container.
|
| Vector2ListField * | addVector2List (const char *name, const std::vector< Vector2 > &value) |
| | Creates an Vector2ListField field with name and given list value and adds it to the container.
|
| Vector3ListField * | addVector3List (const char *name) |
| | Creates an Vector3ListField field with name and empty list value and adds it to the container.
|
| Vector3ListField * | addVector3List (const char *name, const std::vector< Vector3 > &value) |
| | Creates an Vector3ListField field with name and given list value and adds it to the container.
|
| Vector4ListField * | addVector4List (const char *name) |
| | Creates an Vector4ListField field with name and empty list value and adds it to the container.
|
| Vector4ListField * | addVector4List (const char *name, const std::vector< Vector4 > &value) |
| | Creates an Vector4ListField field with name and given list value and adds it to the container.
|
| size_t | getNumFields () const |
| | Returns the number of added fields.
|
| bool | hasField (const std::string &name) const |
| | Returns true if the field with name name exists; otherwise, false is returned.
|
| Field * | getField (const std::string &name) const |
| Field * | getField (MLint index) const |
| | Returns pointer of field at index if it exists. If not, -1 is returned.
|
| MLint | getFieldIndex (Field *field) const |
| | Returns index of field if it exists. If not, -1 is returned.
|
| void | setFieldStringValue (const std::string &name, const std::string &value) |
| std::string | getFieldStringValue (const std::string &name) const |
| virtual void | deactivateAttachments () |
| | Base () |
| | Constructor.
|
| virtual | ~Base () |
| | Destructor.
|
| virtual Base * | deepCopy () const |
| bool | isOfAllowedType (const std::vector< const RuntimeType * > &types) const |
| virtual bool | isRefCountedBase () const |
| | Returns whether the instance is derived from RefCountedBase.
|
| virtual std::string | detailString () const |
| virtual bool | implementsPersistence (PersistenceInterface) const |
| virtual std::string | persistentState () const |
| | Returns a string describing the object's internal state.
|
| virtual void | setPersistentState (const std::string &state) |
| virtual void | addStateToTree (TreeNode *) const |
| | Attaches the object state as children of the given parent node.
|
| virtual void | readStateFromTree (TreeNode *) |
| | Reads the object state from the children of the given parent node.
|
| virtual void | writeTo (AbstractPersistenceOutputStream *) const |
| virtual void | readFrom (AbstractPersistenceInputStream *, int) |
| | CSOGeneratorBase () |
| | Default constructor.
|
| virtual | ~CSOGeneratorBase ()=default |
| CSO * | generatorAddCSO (CSOList *csoList, bool useUndoRedo=true) |
| CSO * | generatorAddCSONoEvent (CSOList *csoList, bool useUndoRedo=true, bool sendEvent=false) |
| | See generatorAddCSO, but no CSOGroup scope event is emitted. (So this method is faster!).
|
| CSOGroup * | generatorGetParentGroup (CSOList *csoList, bool useUndoRedo=false, bool generate=false) |
| | Returns the parent CSOGroup according to current CSOGroup settings.
|
| void | generatorEmptyGroupOnDemand (CSOList *csoList) |
| | Empties a CSOGroup on demand of the given CSOList with the set label.
|
|
| | ~CSOModificator () override |
| | Standard destructor.
|
| void | activateAttachments () override |
| | Initializes the module after loading.
|
| void | handleNotification (Field *field) override |
| | Called when any field changes.
|
| virtual void | resetParsedIds () |
| | Resets parameteres of the modificator.
|
| virtual void | process () |
| virtual void | clearOutput () |
| | Clears all outputs (used by auto clear mode).
|
| virtual std::vector< CSO * > | getCSOsToBeProcessed (const std::vector< CSO * > &csosFromIdList) |
| virtual bool | shouldUseUndoRedo () const |
| | Returns whether undo/Redo should be used.
|
| virtual bool | canProcessInput () |
| virtual void | _setupCSOList () |
| | Sets the _outCSOList correctly.
|
| virtual void | _applyModificator () |
| virtual void | _applyModificatorOnCSOs (const std::vector< CSO * > &csosToBeProcessed) |
| virtual void | _applyModificatorOn (CSO &outputCSO) |
| virtual void | _updateCSOType (CSO &outputCSO) |
| | Updates the CSO's type. Most modules change the type to the modificators name, but not all do it.
|
| virtual void | _notifyObservers (bool didSomething) |
| | Notifies other modules that processing has finished.
|
| virtual bool | shouldTriggerInputChanged (Field *field) const |
| virtual bool | shouldTriggerParameterApplied (Field *field) const |
| bool | _isChangeSettingField (Field *field) const |
| virtual void | _onInputChanged () |
| | Helper methods called by handleNotification, may be overwritten in very special cases.
|
| virtual void | _onParameterApplied () |
| virtual void | _onCSOIdListChanged () |
| virtual void | _onWorkDirectlyOnInputChanged () |
| virtual void | _onApply () |
| bool | _isInIdList (CSO *cso) |
| void | _parseCSOIds (std::set< unsigned int > &ids) |
| | Parse the CSO ID field into the given vector of IDs.
|
| std::vector< CSO * > | _getModifyCSOsFromIdList () |
| void | _storeCurrentStateInUndoManager (std::vector< CSO * > csosToBeProcessed) |
| void | _applyChangedSettings (CSO &cso) const |
| | Changes the settings of the given CSO (only if _changeSettingsForModifiedCSOsFld is true).
|
| | ML_ABSTRACT_MODULE_CLASS_HEADER (CSOModificator) |
| CSO * | _addCSO (CSOList *csoList, bool useUndoRedo=true) |
| CSO * | _addCSONoEvent (CSOList *csoList, bool useUndoRedo=true) |
| | See _addCSO, but without CSOGroup event. (This method is faster!).
|
| CSOGroup * | _getParentGroup (CSOList *csoList, bool useUndoRedo=false, bool generate=false) |
| | Returns the parent CSOGroup according to current CSOGroup settings.
|
| void | _emptyGroupOnDemand (CSOList *csoList) |
| | Empties a CSOGroup on demand of the given CSOList with the set label.
|
| int | getModuleCreatorId () const override |
| | Returns the module's creator ID.
|
| std::string | getModuleType () const override |
| | Returns the module's type string.
|
| bool | getShouldEmptyBeforeGeneration () const override |
| int | getAddCSOToGroupMode () const override |
| | Returns the CSOGroup generation mode.
|
| std::string | getAddCSOToGroupLabel () const override |
| | Returns the label string of a target CSOGroup.
|
| int | getAddCSOToGroupId () const override |
| | Returns the ID of a target CSOGroup.
|
| int | getDefaultPathPointStyle () const override |
| | Returns the set default path point style for a new CSO.
|
| float | getDefaultPathPointWidth () const override |
| | Returns the set default path point width for a new CSO.
|
| Vector3 | getDefaultPathPointColor () const override |
| | Returns the set default path point color for a new CSO.
|
| float | getDefaultPathPointAlpha () const override |
| | Returns the set default path point alpha for a new CSO.
|
| int | getDefaultSeedPointStyle () const override |
| | Returns the set default seed point style for a new CSO.
|
| float | getDefaultSeedPointSize () const override |
| | Returns the set default seed point size for a new CSO.
|
| Vector3 | getDefaultSeedPointColor () const override |
| | Returns the set default seed point color for a new CSO.
|
| float | getDefaultSeedPointAlpha () const override |
| | Returns the set default seed point alpha for a new CSO.
|
| int | getDefaultVoxelWriteMode () const override |
| | Returns the set default voxel write mode for a new CSO.
|
| float | getDefaultVoxelWriteValue () const override |
| | Returns the set default voxel write value for a new CSO.
|
| | ~CSOGenerator () override |
| | Destructor.
|
| | ~CSOBaseModule () override |
| | Standard destructor.
|
| virtual bool | _useLegacyAutoApplyMode () const |
| void | _setIsProcessingFlag (bool newProcessingState) |
| | Sets the isProcessing field if the processing state has changed.
|
| | ML_MODULE_CLASS_HEADER (CSOBaseModule) |
| void | handleNotificationInternal (Field *field, FieldSensor::Strength strength) override |
| virtual CalculateOutputImageHandler * | createCalculateOutputImageHandler (PagedImage *outputImage) |
| virtual void | calculateOutputImageProperties (int outputIndex, PagedImage *outputImage) |
| virtual SubImageBox | calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox, int) |
| virtual void | calculateOutputSubImage (SubImage *outputSubImage, int outputIndex, SubImage *inputSubImages) |
| virtual void | provideCustomPage (int, const SubImageBox &, MLMemoryBlockHandle &) |
| void | handleNotificationOff () |
| void | handleNotificationOn () |
| bool | isHandleNotificationOn () |
| | Returns true if handleNotification calls are permitted; otherwise, it returns false.
|
| void | setOutputImageInplace (MLint outputIndex=0, MLint inputIndex=0) |
| void | unsetOutputImageInplace (MLint outputIndex=0) |
| void | setBypass (MLint outputIndex=0, MLint inputIndex=0) |
| void | setClampPagesToImageExtent (bool flag=true) |
| void | setThreadSupport (THREAD_SUPPORT supportMode) |
| void | permitRecursiveHandleNotifications (bool enable) |
| void | setVoxelDataTypeSupport (PERMITTED_TYPES permTypes) |
