Base class for extensions that extend the editor with interaction and rendering for specific CSO types and that can create new CSOs. More...
#include <SoCSOCreatorEditorExtension.h>
Public Member Functions | |
| virtual bool | canCreateCSOs () const |
| Returns whether the editor can create a CSO. | |
Static Public Member Functions | |
| static void | initClass () |
| init class in inventor runtime | |
Public Attributes | |
| SoSFInt32 | moduleCreatorId |
| Sets the module's creator id. | |
| SoSFString | moduleCreatorString |
| Sets the module's type string. | |
| SoSFString | labelPrefixString |
| Sets a label prefix string. | |
| SoSFBool | requirePointerPositionMovementToCreateCSO |
| Should the mouse have to be moved a bit before creating a CSO? | |
| SoSFInt32 | pointerPositionEpsilonForCreatingCSO |
| The pointer position movement epsilon distance in pixel to trigger CSO creation. | |
| SoSFBool | shouldEmptyGroupBeforeGenerating |
| Should the CSO group be emptied before generating new CSOs into it? | |
| SoSFEnum | addCSOToGroupMode |
| Sets whether the group's label or its id should be used for cso-into-group generation. | |
| SoSFString | addCSOToGroupLabel |
| Sets the group's label for CSO generation. | |
| SoSFInt32 | addCSOToGroupId |
| Sets the group's id for CSO generation. | |
| SoSFEnum | defaultPathPointStyle |
| Sets the default path point style. | |
| SoSFFloat | defaultPathPointWidth |
| Sets the default path point width. | |
| SoSFColor | defaultPathPointColor |
| Sets the default path point color. | |
| SoSFFloat | defaultPathPointAlpha |
| Sets the default path point alpha. | |
| SoSFEnum | defaultSeedPointStyle |
| Sets the default seed point style. | |
| SoSFFloat | defaultSeedPointSize |
| Sets the default seed point size. | |
| SoSFColor | defaultSeedPointColor |
| Sets the default seed point color. | |
| SoSFFloat | defaultSeedPointAlpha |
| Sets the default seed point alpha. | |
| SoSFEnum | defaultVoxelWriteMode |
| Sets the default voxel write mode. | |
| SoSFFloat | defaultVoxelWriteValue |
| Sets the default voxel write value. | |
Protected Member Functions | |
| SoCSOCreatorEditorExtension () | |
| Hidden constructor. | |
| virtual int | getModuleCreatorId () const |
| Returns the module's creator id. | |
| virtual std::string | getModuleType () const |
| Returns the module's type string. | |
| virtual void | setCreationData (const SoPointerPosition &pos, ml::CSO *newCSO) |
| Sets creation data to a newly created CSO. | |
| int | getMaxAvailableId () |
| Returns the current id for CSOs created by this editor. It is the maximum available id. | |
| virtual bool | getShouldEmptyBeforeGeneration () const |
| Returns whether the module should empty a group before generating CSOs into it. | |
| virtual int | getAddCSOToGroupMode () const |
| Returns the group generation mode. | |
| virtual std::string | getAddCSOToGroupLabel () const |
| Returns the label string of a target group. | |
| virtual int | getAddCSOToGroupId () const |
| Returns the id of a target group. | |
| virtual int | getDefaultPathPointStyle () const |
| Returns the set default path point style for a new CSO. | |
| virtual float | getDefaultPathPointWidth () const |
| Returns the set default path point width for a new CSO. | |
| virtual ml::Vector3 | getDefaultPathPointColor () const |
| Returns the set default path point color for a new CSO. | |
| virtual float | getDefaultPathPointAlpha () const |
| Returns the set default path point alpha for a new CSO. | |
| virtual int | getDefaultSeedPointStyle () const |
| Returns the set default seed point style for a new CSO. | |
| virtual float | getDefaultSeedPointSize () const |
| Returns the set default seed point size for a new CSO. | |
| virtual ml::Vector3 | getDefaultSeedPointColor () const |
| Returns the set default seed point color for a new CSO. | |
| virtual float | getDefaultSeedPointAlpha () const |
| Returns the set default seed point alpha for a new CSO. | |
| virtual int | getDefaultVoxelWriteMode () const |
| Returns the set default voxel write mode for a new CSO. | |
| virtual float | getDefaultVoxelWriteValue () const |
| Returns the set default voxel write value for a new CSO. | |
| bool | isFartherThanEpsilon (const SoPointerPosition &pos) const |
| Returns whether the given position is farther away from the start position than the epsilon in pixel. | |
Protected Attributes | |
| SbVec2f | _startDevicePointerPosition |
| The device position of the pointer at creation start. | |
Detailed Description
Base class for extensions that extend the editor with interaction and rendering for specific CSO types and that can create new CSOs.
Definition at line 25 of file SoCSOCreatorEditorExtension.h.
Constructor & Destructor Documentation
| SoCSOCreatorEditorExtension::SoCSOCreatorEditorExtension | ( | ) | [protected] |
Hidden constructor.
Member Function Documentation
| virtual bool SoCSOCreatorEditorExtension::canCreateCSOs | ( | ) | const [inline, virtual] |
Returns whether the editor can create a CSO.
Reimplemented from SoCSOEditorExtension.
Definition at line 35 of file SoCSOCreatorEditorExtension.h.
| virtual int SoCSOCreatorEditorExtension::getAddCSOToGroupId | ( | ) | const [inline, protected, virtual] |
Returns the id of a target group.
Implements ml::CSOGeneratorBase.
Definition at line 105 of file SoCSOCreatorEditorExtension.h.
| virtual std::string SoCSOCreatorEditorExtension::getAddCSOToGroupLabel | ( | ) | const [inline, protected, virtual] |
Returns the label string of a target group.
Implements ml::CSOGeneratorBase.
Definition at line 103 of file SoCSOCreatorEditorExtension.h.
| virtual int SoCSOCreatorEditorExtension::getAddCSOToGroupMode | ( | ) | const [inline, protected, virtual] |
Returns the group generation mode.
Implements ml::CSOGeneratorBase.
Definition at line 101 of file SoCSOCreatorEditorExtension.h.
| virtual float SoCSOCreatorEditorExtension::getDefaultPathPointAlpha | ( | ) | const [inline, protected, virtual] |
Returns the set default path point alpha for a new CSO.
Implements ml::CSOGeneratorBase.
Definition at line 118 of file SoCSOCreatorEditorExtension.h.
| virtual ml::Vector3 SoCSOCreatorEditorExtension::getDefaultPathPointColor | ( | ) | const [inline, protected, virtual] |
Returns the set default path point color for a new CSO.
Implements ml::CSOGeneratorBase.
Definition at line 112 of file SoCSOCreatorEditorExtension.h.
| virtual int SoCSOCreatorEditorExtension::getDefaultPathPointStyle | ( | ) | const [inline, protected, virtual] |
Returns the set default path point style for a new CSO.
Implements ml::CSOGeneratorBase.
Definition at line 108 of file SoCSOCreatorEditorExtension.h.
| virtual float SoCSOCreatorEditorExtension::getDefaultPathPointWidth | ( | ) | const [inline, protected, virtual] |
Returns the set default path point width for a new CSO.
Implements ml::CSOGeneratorBase.
Definition at line 110 of file SoCSOCreatorEditorExtension.h.
| virtual float SoCSOCreatorEditorExtension::getDefaultSeedPointAlpha | ( | ) | const [inline, protected, virtual] |
Returns the set default seed point alpha for a new CSO.
Implements ml::CSOGeneratorBase.
Definition at line 131 of file SoCSOCreatorEditorExtension.h.
| virtual ml::Vector3 SoCSOCreatorEditorExtension::getDefaultSeedPointColor | ( | ) | const [inline, protected, virtual] |
Returns the set default seed point color for a new CSO.
Implements ml::CSOGeneratorBase.
Definition at line 125 of file SoCSOCreatorEditorExtension.h.
| virtual float SoCSOCreatorEditorExtension::getDefaultSeedPointSize | ( | ) | const [inline, protected, virtual] |
Returns the set default seed point size for a new CSO.
Implements ml::CSOGeneratorBase.
Definition at line 123 of file SoCSOCreatorEditorExtension.h.
| virtual int SoCSOCreatorEditorExtension::getDefaultSeedPointStyle | ( | ) | const [inline, protected, virtual] |
Returns the set default seed point style for a new CSO.
Implements ml::CSOGeneratorBase.
Definition at line 121 of file SoCSOCreatorEditorExtension.h.
| virtual int SoCSOCreatorEditorExtension::getDefaultVoxelWriteMode | ( | ) | const [inline, protected, virtual] |
Returns the set default voxel write mode for a new CSO.
Implements ml::CSOGeneratorBase.
Definition at line 134 of file SoCSOCreatorEditorExtension.h.
| virtual float SoCSOCreatorEditorExtension::getDefaultVoxelWriteValue | ( | ) | const [inline, protected, virtual] |
Returns the set default voxel write value for a new CSO.
Implements ml::CSOGeneratorBase.
Definition at line 136 of file SoCSOCreatorEditorExtension.h.
| int SoCSOCreatorEditorExtension::getMaxAvailableId | ( | ) | [protected] |
Returns the current id for CSOs created by this editor. It is the maximum available id.
| virtual int SoCSOCreatorEditorExtension::getModuleCreatorId | ( | ) | const [inline, protected, virtual] |
Returns the module's creator id.
Implements ml::CSOGeneratorBase.
Definition at line 87 of file SoCSOCreatorEditorExtension.h.
| virtual std::string SoCSOCreatorEditorExtension::getModuleType | ( | ) | const [inline, protected, virtual] |
Returns the module's type string.
Implements ml::CSOGeneratorBase.
Definition at line 89 of file SoCSOCreatorEditorExtension.h.
| virtual bool SoCSOCreatorEditorExtension::getShouldEmptyBeforeGeneration | ( | ) | const [inline, protected, virtual] |
Returns whether the module should empty a group before generating CSOs into it.
Implements ml::CSOGeneratorBase.
Definition at line 99 of file SoCSOCreatorEditorExtension.h.
| static void SoCSOCreatorEditorExtension::initClass | ( | ) | [static] |
init class in inventor runtime
Reimplemented from SoCSOEditorExtension.
Reimplemented in SoCSODistanceLineEditor, SoCSODistancePolylineEditor, SoCSOEllipseEditor, SoCSOPointEditor, SoCSOPolygonEditor, SoCSOSplineEditor, and SoCSOLineCreatorEditorExtension.
| bool SoCSOCreatorEditorExtension::isFartherThanEpsilon | ( | const SoPointerPosition & | pos | ) | const [protected] |
Returns whether the given position is farther away from the start position than the epsilon in pixel.
| virtual void SoCSOCreatorEditorExtension::setCreationData | ( | const SoPointerPosition & | pos, |
| ml::CSO * | newCSO | ||
| ) | [protected, virtual] |
Sets creation data to a newly created CSO.
Reimplemented from SoCSOEditorExtension.
Member Data Documentation
SbVec2f SoCSOCreatorEditorExtension::_startDevicePointerPosition [protected] |
The device position of the pointer at creation start.
Definition at line 143 of file SoCSOCreatorEditorExtension.h.
Sets the group's id for CSO generation.
Definition at line 59 of file SoCSOCreatorEditorExtension.h.
Sets the group's label for CSO generation.
Definition at line 57 of file SoCSOCreatorEditorExtension.h.
Sets whether the group's label or its id should be used for cso-into-group generation.
Definition at line 55 of file SoCSOCreatorEditorExtension.h.
Sets the default path point alpha.
Definition at line 67 of file SoCSOCreatorEditorExtension.h.
Sets the default path point color.
Definition at line 65 of file SoCSOCreatorEditorExtension.h.
Sets the default path point style.
Definition at line 61 of file SoCSOCreatorEditorExtension.h.
Sets the default path point width.
Definition at line 63 of file SoCSOCreatorEditorExtension.h.
Sets the default seed point alpha.
Definition at line 75 of file SoCSOCreatorEditorExtension.h.
Sets the default seed point color.
Definition at line 73 of file SoCSOCreatorEditorExtension.h.
Sets the default seed point size.
Definition at line 71 of file SoCSOCreatorEditorExtension.h.
Sets the default seed point style.
Definition at line 69 of file SoCSOCreatorEditorExtension.h.
Sets the default voxel write mode.
Definition at line 77 of file SoCSOCreatorEditorExtension.h.
Sets the default voxel write value.
Definition at line 79 of file SoCSOCreatorEditorExtension.h.
Sets a label prefix string.
Definition at line 45 of file SoCSOCreatorEditorExtension.h.
Sets the module's creator id.
Definition at line 41 of file SoCSOCreatorEditorExtension.h.
Sets the module's type string.
Definition at line 43 of file SoCSOCreatorEditorExtension.h.
The pointer position movement epsilon distance in pixel to trigger CSO creation.
Definition at line 50 of file SoCSOCreatorEditorExtension.h.
Should the mouse have to be moved a bit before creating a CSO?
Definition at line 48 of file SoCSOCreatorEditorExtension.h.
Should the CSO group be emptied before generating new CSOs into it?
Definition at line 53 of file SoCSOCreatorEditorExtension.h.
The documentation for this class was generated from the following file:
- MeVisLab/Standard/Sources/Inventor/SoCSO/SoView2DCSOEditor/SoView2DCSOExtensibleEditor/SoCSOCreatorEditorExtension.h
