TextureManipulator.TextureManipulator Class Reference
#include
<class_texture_manipulator_1_1_texture_manipulator.h>
Public Member Functions |
|
| __init__ () | |
| cleanup () | |
| Clean-up all our references to complex
objects. |
|
| createProjectionGeometry () | |
| Classes inheriting from this class should
implement this method. |
|
| getKeyMappingId () | |
| Classes inheriting from this class should
implement this method. |
|
| getKeyMappingInteractionId () | |
| Classes inheriting from this class should
implement this method. |
|
| getGeometryFileName () | |
| Classes inheriting from this class should
implement this method. |
|
| getKeyMappings () | |
| This method should return a key mapping
linked to the specified callbacks. |
|
| getKeyMappingsInteraction () | |
| This key mapping is only activated when an
interaction has started, ie. |
|
| getDefaultPivot () | |
| Compute the default pivot for the particular
manipulator. |
|
| isOfType () | |
| This method returns true if the manipulator
modifies the specified projection type, represented as a parameter
constant. |
|
| setParameters () | |
| getParameters () | |
| Returns a dictionary with the parameter name
in it. |
|
| getParameterName () | |
| setDocument () | |
| getModels () | |
| getTargetIds () | |
| Returns the tuple of ids of the model nodes
that are to be manipulated. |
|
| areLocatorsSelected () | |
| setContextMessage () | |
| Set the messages which depends on document
type, they will be set by context class. |
|
| getContextMessage () | |
| getProjectionGeometry () | |
| getObjectToWorldMatrix () | |
| setMode () | |
| Override this method in the derived class to
enable setting modes. |
|
| isInMode () | |
| recordValues () | |
| Queries and stores the parameter value for
each node's material. |
|
| getMaterialParameterValue () | |
| Returns a string that represents the given
parameter on the given material. |
|
| getParameterValue () | |
| Returns a string that represents the given
parameter on the node's material. |
|
| undo () | |
| computeGeometryScaleFactor () | |
| getTargetBoundingBox () | |
| getTextureMatrix () | |
| Utility method to retrieve the unit cube to
world matrix. |
|
| enable () | |
| Enables/disables this manipulator. |
|
| setTargetIds () | |
| Sets the list or tuple of ids whose
corresponding model nodes become the targets to be manipulated.
|
|
| setLocatorTargetIds () | |
| Sets the list or tuple of locators ids and
corresponding model ids whose corresponding nodes become the
targets to be manipulated. |
|
| initialize () | |
| Creates and configures the handles of this
manipulator given the geometry root. |
|
| refresh () | |
| Moves the manipulator to the center of the
targets, and scales it based on the distance from the eye to the
manipulator center. |
|
| isManipulatorDirty () | |
| needsRefresh () | |
| Returns True if the manipulator is enabled,
its geometry has loaded, the display has been set, and the targets
or the view has changed; False otherwise. |
|
| handleEvent () | |
| Override this in the derived class to
perform operations such as redrawing per frame. |
|
| doResize () | |
| The policy of resizing manipulators are
diffrent in each subclass. |
|
| TextureManipulatorStart () | |
| TextureManipulatorStop () | |
| TextureManipulatorUpdate () | |
| TextureManipulatorNoOp () | |
| This method is specifically to consume
release events that otherwise would cause the selection to change.
|
|
| TextureTogglePivotMode () | |
| TextureSnapToIncrementEnable () | |
| TextureSnapToIncrementDisable () | |
| APPLICATION_CLOSE_SCENE () | |
| forceRefresh () | |
| TEXTURE_TRANSFORM_START_HELPER () | |
| TEXTURE_TRANSFORM_DONE () | |
| TEXTURE_TRANSFORM_SET_PIVOT () | |
| Accepts a pivot point in world space and
sets the pivot. |
|
| TEXTURE_TRANSFORM_PIVOT_DONE () | |
| If the manipulator is in move pivot mode,
set the mode back to texture manipulation. |
|
| ROTATE_WORLDSPACE_DONE () | |
| TRANSLATE_WORLDSPACE_DONE () | |
| SCALE_WORLDSPACE_DONE () | |
| MODEL_SCALED () | |
| MODEL_UP_AXIS_SWITCHED () | |
| MODEL_UP_AXIS_TRANSFORM_CHANGED () | |
| GEOMETRY_SCALED () | |
| GEOMETRY_UP_AXIS_SWITCHED () | |
| GEOMETRY_TRANSFORM_CHANGED () | |
| ALTERNATIVE_DELETED () | |
| ALTERNATIVE_SET_CHANGED () | |
| SET_DISPLAY_POSITION_AND_SIZE () | |
| WINDOW_SET_SIZE () | |
| DISPLAY_VERTICAL_FOV_CHANGED () | |
| NAVIGATION_POSITION () | |
| QUIT () | |
| SET_3D_UI_ROOT () | |
| DOCUMENT_UNITS_CHANGED () | |
Public Attributes |
|
| myOnlyMaterials | |
Member Function Documentation
| TextureManipulator.TextureManipulator.__init__ | ( | ) |
| TextureManipulator.TextureManipulator.cleanup | ( | ) |
Clean-up all our references to complex objects.
Reimplemented from Manipulator.Manipulator.
Reimplemented in TextureManipulator.CylindricalTextureManipulator.
| TextureManipulator.TextureManipulator.createProjectionGeometry | ( | ) |
Classes inheriting from this class should implement this method.
Projection geometry (unit cube/cylinder etc...) being rendered along with the manipulator should be returned here
Reimplemented in TextureManipulator.CylindricalTextureManipulator, TextureManipulator.EquirectangularTextureManipulator, TextureManipulator.PlanarTextureManipulator, and TextureManipulator.TriPlanarTextureManipulator.
| TextureManipulator.TextureManipulator.getKeyMappingId | ( | ) |
Classes inheriting from this class should implement this method.
This method should return a unique id that can be used to name a key mapping that initiates an interaction.
Reimplemented in TextureManipulator.CylindricalTextureManipulator, TextureManipulator.EquirectangularTextureManipulator, TextureManipulator.PlanarTextureManipulator, and TextureManipulator.TriPlanarTextureManipulator.
| TextureManipulator.TextureManipulator.getKeyMappingInteractionId | ( | ) |
Classes inheriting from this class should implement this method.
This method should return a unique id that can be used to name a key mapping that performs an interaction.
Reimplemented in TextureManipulator.CylindricalTextureManipulator, TextureManipulator.EquirectangularTextureManipulator, TextureManipulator.PlanarTextureManipulator, and TextureManipulator.TriPlanarTextureManipulator.
| TextureManipulator.TextureManipulator.getGeometryFileName | ( | ) |
Classes inheriting from this class should implement this method.
This method should return the file name of the manipulator geometry file.
Reimplemented in TextureManipulator.CylindricalTextureManipulator, TextureManipulator.EquirectangularTextureManipulator, TextureManipulator.PlanarTextureManipulator, and TextureManipulator.TriPlanarTextureManipulator.
| TextureManipulator.TextureManipulator.getKeyMappings | ( | ) |
This method should return a key mapping linked to the specified callbacks.
Due to a limitation in the messaging dispatcher unless each callback has a unique name, the wrong class method may be called.
This mapping contains only those events that are needed to initiate an interaction. Once the interaction has started, ie. the user has clicked on a manipulator handle, then the interaction key mapping is activated (see below).
It is expected that an inherited class will add a callback for each of the press and release methods, and then call the base class's methods for press and release (sometimes called start/stop)
i.e. fooManipulator should provide key mappings: fooStart, fooStop Each of these methods in turn, should call the base class TextureManipulatorStart/Stop
Reimplemented in TextureManipulator.CylindricalTextureManipulator, TextureManipulator.EquirectangularTextureManipulator, TextureManipulator.PlanarTextureManipulator, and TextureManipulator.TriPlanarTextureManipulator.
| TextureManipulator.TextureManipulator.getKeyMappingsInteraction | ( | ) |
This key mapping is only activated when an interaction has started, ie.
the user has clicked on a handle and the manipulator needs to catch and process subsequent drag and release events.
i.e. fooManipulator should provide key mappings: fooStop, fooUpdate. Each of these methods in turn, should call the base class TextureManipulatorStop/Update.
Reimplemented in TextureManipulator.CylindricalTextureManipulator, TextureManipulator.EquirectangularTextureManipulator, TextureManipulator.PlanarTextureManipulator, and TextureManipulator.TriPlanarTextureManipulator.
| TextureManipulator.TextureManipulator.getDefaultPivot | ( | ) |
Compute the default pivot for the particular manipulator.
This method is called when the manipulator is initialized to position the pivot in an appropriate place.
Reimplemented in TextureManipulator.PlanarTextureManipulator.
| TextureManipulator.TextureManipulator.isOfType | ( | ) |
This method returns true if the manipulator modifies the specified projection type, represented as a parameter constant.
Reimplemented in TextureManipulator.CylindricalTextureManipulator, TextureManipulator.EquirectangularTextureManipulator, TextureManipulator.PlanarTextureManipulator, and TextureManipulator.TriPlanarTextureManipulator.
| TextureManipulator.TextureManipulator.setParameters | ( | ) |
Reimplemented in TextureManipulator.CylindricalTextureManipulator.
| TextureManipulator.TextureManipulator.getParameters | ( | ) |
Returns a dictionary with the parameter name in it.
| TextureManipulator.TextureManipulator.getParameterName | ( | ) |
| TextureManipulator.TextureManipulator.setDocument | ( | ) |
| TextureManipulator.TextureManipulator.getModels | ( | ) |
| TextureManipulator.TextureManipulator.getTargetIds | ( | ) |
Returns the tuple of ids of the model nodes that are to be manipulated.
Reimplemented from Manipulator.Manipulator.
| TextureManipulator.TextureManipulator.areLocatorsSelected | ( | ) |
Reimplemented from Manipulator.Manipulator.
| TextureManipulator.TextureManipulator.setContextMessage | ( | ) |
Set the messages which depends on document type, they will be set by context class.
| TextureManipulator.TextureManipulator.getContextMessage | ( | ) |
| TextureManipulator.TextureManipulator.getProjectionGeometry | ( | ) |
| TextureManipulator.TextureManipulator.getObjectToWorldMatrix | ( | ) |
| TextureManipulator.TextureManipulator.setMode | ( | ) |
Override this method in the derived class to enable setting modes.
This implementation returns false to indicate that the mode of the manipulator has not changed / nothing has happened.
Reimplemented from Manipulator.Manipulator.
| TextureManipulator.TextureManipulator.isInMode | ( | ) |
| TextureManipulator.TextureManipulator.recordValues | ( | ) |
Queries and stores the parameter value for each node's material.
Returns a dictionary whose keys are the parameter values as strings, and a list of nodeIds that have the same parameter value as the value.
Note, this is a private method, not to be used outside this module.
| TextureManipulator.TextureManipulator.getMaterialParameterValue | ( | ) |
Returns a string that represents the given parameter on the given material.
| TextureManipulator.TextureManipulator.getParameterValue | ( | ) |
Returns a string that represents the given parameter on the node's material.
| TextureManipulator.TextureManipulator.undo | ( | ) |
| TextureManipulator.TextureManipulator.computeGeometryScaleFactor | ( | ) |
| TextureManipulator.TextureManipulator.getTargetBoundingBox | ( | ) |
| TextureManipulator.TextureManipulator.getTextureMatrix | ( | ) |
Utility method to retrieve the unit cube to world matrix.
| TextureManipulator.TextureManipulator.enable | ( | ) |
Enables/disables this manipulator.
The manipulator is made visible and invisible, respectively. If an interaction is in progress, then the interaction is stopped.
Reimplemented from Manipulator.Manipulator.
Reimplemented in TextureManipulator.CylindricalTextureManipulator.
| TextureManipulator.TextureManipulator.setTargetIds | ( | ) |
Sets the list or tuple of ids whose corresponding model nodes become the targets to be manipulated.
Reimplemented from Manipulator.Manipulator.
| TextureManipulator.TextureManipulator.setLocatorTargetIds | ( | ) |
Sets the list or tuple of locators ids and corresponding model ids whose corresponding nodes become the targets to be manipulated.
Reimplemented from Manipulator.Manipulator.
| TextureManipulator.TextureManipulator.initialize | ( | ) |
Creates and configures the handles of this manipulator given the geometry root.
Reimplemented from Manipulator.Manipulator.
| TextureManipulator.TextureManipulator.refresh | ( | ) |
Moves the manipulator to the center of the targets, and scales it based on the distance from the eye to the manipulator center.
Reimplemented from Manipulator.Manipulator.
Reimplemented in TextureManipulator.CylindricalTextureManipulator.
| TextureManipulator.TextureManipulator.isManipulatorDirty | ( | ) |
| TextureManipulator.TextureManipulator.needsRefresh | ( | ) |
Returns True if the manipulator is enabled, its geometry has loaded, the display has been set, and the targets or the view has changed; False otherwise.
Reimplemented from Manipulator.Manipulator.
| TextureManipulator.TextureManipulator.handleEvent | ( | ) |
Override this in the derived class to perform operations such as redrawing per frame.
Reimplemented from Manipulator.Manipulator.
| TextureManipulator.TextureManipulator.doResize | ( | ) |
The policy of resizing manipulators are diffrent in each subclass.
This function provides the right policy.
Reimplemented from Manipulator.Manipulator.
| TextureManipulator.TextureManipulator.TextureManipulatorStart | ( | ) |
| TextureManipulator.TextureManipulator.TextureManipulatorStop | ( | ) |
| TextureManipulator.TextureManipulator.TextureManipulatorUpdate | ( | ) |
| TextureManipulator.TextureManipulator.TextureManipulatorNoOp | ( | ) |
This method is specifically to consume release events that otherwise would cause the selection to change.
| TextureManipulator.TextureManipulator.TextureTogglePivotMode | ( | ) |
| TextureManipulator.TextureManipulator.TextureSnapToIncrementEnable | ( | ) |
| TextureManipulator.TextureManipulator.TextureSnapToIncrementDisable | ( | ) |
| TextureManipulator.TextureManipulator.APPLICATION_CLOSE_SCENE | ( | ) |
| TextureManipulator.TextureManipulator.forceRefresh | ( | ) |
| TextureManipulator.TextureManipulator.TEXTURE_TRANSFORM_START_HELPER | ( | ) |
| TextureManipulator.TextureManipulator.TEXTURE_TRANSFORM_DONE | ( | ) |
| TextureManipulator.TextureManipulator.TEXTURE_TRANSFORM_SET_PIVOT | ( | ) |
Accepts a pivot point in world space and sets the pivot.
| TextureManipulator.TextureManipulator.TEXTURE_TRANSFORM_PIVOT_DONE | ( | ) |
If the manipulator is in move pivot mode, set the mode back to texture manipulation.
| TextureManipulator.TextureManipulator.ROTATE_WORLDSPACE_DONE | ( | ) |
| TextureManipulator.TextureManipulator.TRANSLATE_WORLDSPACE_DONE | ( | ) |
| TextureManipulator.TextureManipulator.SCALE_WORLDSPACE_DONE | ( | ) |
| TextureManipulator.TextureManipulator.MODEL_SCALED | ( | ) |
| TextureManipulator.TextureManipulator.MODEL_UP_AXIS_SWITCHED | ( | ) |
| TextureManipulator.TextureManipulator.MODEL_UP_AXIS_TRANSFORM_CHANGED | ( | ) |
| TextureManipulator.TextureManipulator.GEOMETRY_SCALED | ( | ) |
| TextureManipulator.TextureManipulator.GEOMETRY_UP_AXIS_SWITCHED | ( | ) |
| TextureManipulator.TextureManipulator.GEOMETRY_TRANSFORM_CHANGED | ( | ) |
| TextureManipulator.TextureManipulator.ALTERNATIVE_DELETED | ( | ) |
| TextureManipulator.TextureManipulator.ALTERNATIVE_SET_CHANGED | ( | ) |
| TextureManipulator.TextureManipulator.SET_DISPLAY_POSITION_AND_SIZE | ( | ) |
| TextureManipulator.TextureManipulator.WINDOW_SET_SIZE | ( | ) |
| TextureManipulator.TextureManipulator.DISPLAY_VERTICAL_FOV_CHANGED | ( | ) |
| TextureManipulator.TextureManipulator.NAVIGATION_POSITION | ( | ) |
| TextureManipulator.TextureManipulator.QUIT | ( | ) |
| TextureManipulator.TextureManipulator.SET_3D_UI_ROOT | ( | ) |
| TextureManipulator.TextureManipulator.DOCUMENT_UNITS_CHANGED | ( | ) |
