Om
1.0.0
A universal framework for multimedia simulation
|
An interface for classes that use a GUI to edit an instance of a resource type. More...
#include <omResourceTypeEditor.h>
Classes | |
class | Delegate |
A class that contains function objects that recieve resource type editor events. More... | |
Public Member Functions | |
ResourceTypeEditor () | |
Create a new resource type editor that has no resource set. More... | |
ResourceTypeEditor (const EditorServices &newServices) | |
Create a new resource type editor that uses the specified resource set. More... | |
virtual | ~ResourceTypeEditor () |
Destroy this resource type editor and release all internal resources. More... | |
virtual OpaqueResource | getResource () const =0 |
Return an opaque pointer to the resource that is currently being edited. More... | |
virtual const ResourceType & | getResourceType () const =0 |
Return the resource type that this editor is able to edit. More... | |
virtual GUIImage | getResourceIcon (const Vector2f &size) const =0 |
Return an image that represents the icon for the edited resource. More... | |
virtual om::graphics::gui::GUIObject * | getMainView () const =0 |
Return a pointer to a GUI object that should be used as the main view for this editor. More... | |
virtual om::graphics::gui::GUIObject * | getMiniView () const |
Return a pointer to a GUI object that should be used as the mini view for this editor. More... | |
OM_INLINE const EditorServices & | getServices () const |
Return a reference to the external services for this resource type editor. More... | |
virtual void | setServices (const EditorServices &newServices) |
Set the external services for this resource type editor. More... | |
OM_INLINE const Delegate & | getDelegate () const |
Return a reference to the delegate for this resource type editor. More... | |
virtual void | setDelegate (const Delegate &newDelegate) |
Set the delegate for this resource type editor. More... | |
virtual void | editedResource (const OpaqueResource &resource) |
A method that should be called when a resource used by the editor is modified. More... | |
virtual Bool | getSelectedResource (OpaqueResource &resource) const |
Get an opaque reference to the currently selected resource in the editor. More... | |
virtual Size | getInputCount () const |
Return the number of input data connections there are for this editor's resource. More... | |
virtual Size | getOutputCount () const |
Return the number of output data connections there are for this editor's resource. More... | |
virtual const ResourceType & | getInputType (Index inputIndex) const |
Return the resource type of the input data connection for this editor's resource at the specified index. More... | |
virtual const ResourceType & | getOutputType (Index outputIndex) const |
Return the resource type of the output data connection for this editor's resource at the specified index. More... | |
virtual UTF8String | getInputName (Index inputIndex) const |
Return the name of the input data connection for this editor's resource at the specified index. More... | |
virtual UTF8String | getOutputName (Index outputIndex) const |
Return the name of the output data connection for this editor's resource at the specified index. More... | |
virtual GUIImage | getInputIcon (Index inputIndex, const Vector2f &size) const |
Return the icon of the input data connection for this editor's resource at the specified index. More... | |
virtual GUIImage | getOutputIcon (Index outputIndex, const Vector2f &size) const |
Return the icon of the output data connection for this editor's resource at the specified index. More... | |
virtual OpaqueResource | newInputConnection (Index inputIndex) const |
Construct and return a pointer to a new input connection at the specified index. More... | |
virtual OpaqueResource | newOutputConnection (Index outputIndex) const |
Construct and return a pointer to a new output connection at the specified index. More... | |
virtual OpaqueResource | newInputConnector (Index inputIndex, const OpaqueResource &connection) const |
Construct and return a pointer to a new input connector at the specified index. More... | |
virtual OpaqueResource | newOutputConnector (Index outputIndex, const OpaqueResource &connection) const |
Construct and return a pointer to a new output connector at the specified index. More... | |
Protected Attributes | |
EditorServices | services |
An object that contains the external services for this editor. More... | |
Delegate | delegate |
An object that responds to events for this resource type editor. More... | |
An interface for classes that use a GUI to edit an instance of a resource type.
om::editors::base::ResourceTypeEditor::ResourceTypeEditor | ( | ) |
Create a new resource type editor that has no resource set.
om::editors::base::ResourceTypeEditor::ResourceTypeEditor | ( | const EditorServices & | newServices | ) |
Create a new resource type editor that uses the specified resource set.
|
virtual |
Destroy this resource type editor and release all internal resources.
|
pure virtual |
Return an opaque pointer to the resource that is currently being edited.
Implemented in om::editors::types::PrototypeEditor, om::editors::types::ConstraintEditor, om::editors::types::ForceFieldEditor, om::editors::types::GraphicsMaterialEditor, om::editors::types::GraphicsObjectEditor, om::editors::types::GraphicsShapeEditor, om::editors::types::PhysicsMaterialEditor, om::editors::types::PhysicsObjectEditor, om::editors::types::PhysicsShapeEditor, om::editors::types::ResourceGroupEditor, om::editors::types::ResourceSetEditor, om::editors::types::SceneEditor, om::editors::types::SequencerEditor, om::editors::types::SoundListenerEditor, om::editors::types::SoundMaterialEditor, om::editors::types::SoundObjectEditor, om::editors::types::SoundPluginEditor, om::editors::types::SoundShapeEditor, om::editors::types::SoundSourceEditor, om::editors::types::CameraEditor, om::editors::types::ForceEditor, om::editors::types::ImageEditor, and om::editors::types::SoundEditor.
|
pure virtual |
Return the resource type that this editor is able to edit.
Implemented in om::editors::types::PrototypeEditor, om::editors::types::ConstraintEditor, om::editors::types::ForceFieldEditor, om::editors::types::GraphicsMaterialEditor, om::editors::types::GraphicsObjectEditor, om::editors::types::GraphicsShapeEditor, om::editors::types::PhysicsMaterialEditor, om::editors::types::PhysicsObjectEditor, om::editors::types::PhysicsShapeEditor, om::editors::types::ResourceGroupEditor, om::editors::types::ResourceSetEditor, om::editors::types::SceneEditor, om::editors::types::SequencerEditor, om::editors::types::SoundListenerEditor, om::editors::types::SoundMaterialEditor, om::editors::types::SoundObjectEditor, om::editors::types::SoundPluginEditor, om::editors::types::SoundShapeEditor, om::editors::types::SoundSourceEditor, om::editors::types::CameraEditor, om::editors::types::ForceEditor, om::editors::types::ImageEditor, and om::editors::types::SoundEditor.
|
pure virtual |
Return an image that represents the icon for the edited resource.
Implemented in om::editors::types::PrototypeEditor, om::editors::types::ConstraintEditor, om::editors::types::ForceFieldEditor, om::editors::types::GraphicsMaterialEditor, om::editors::types::GraphicsObjectEditor, om::editors::types::GraphicsShapeEditor, om::editors::types::PhysicsMaterialEditor, om::editors::types::PhysicsObjectEditor, om::editors::types::PhysicsShapeEditor, om::editors::types::ResourceGroupEditor, om::editors::types::ResourceSetEditor, om::editors::types::SceneEditor, om::editors::types::SequencerEditor, om::editors::types::SoundListenerEditor, om::editors::types::SoundMaterialEditor, om::editors::types::SoundObjectEditor, om::editors::types::SoundPluginEditor, om::editors::types::SoundShapeEditor, om::editors::types::SoundSourceEditor, om::editors::types::CameraEditor, om::editors::types::ForceEditor, om::editors::types::ImageEditor, and om::editors::types::SoundEditor.
|
pure virtual |
Return a pointer to a GUI object that should be used as the main view for this editor.
Implemented in om::editors::types::PrototypeEditor, om::editors::types::ConstraintEditor, om::editors::types::ForceFieldEditor, om::editors::types::GraphicsMaterialEditor, om::editors::types::GraphicsObjectEditor, om::editors::types::GraphicsShapeEditor, om::editors::types::PhysicsMaterialEditor, om::editors::types::PhysicsObjectEditor, om::editors::types::PhysicsShapeEditor, om::editors::types::ResourceGroupEditor, om::editors::types::ResourceSetEditor, om::editors::types::SceneEditor, om::editors::types::SequencerEditor, om::editors::types::SoundListenerEditor, om::editors::types::SoundMaterialEditor, om::editors::types::SoundObjectEditor, om::editors::types::SoundPluginEditor, om::editors::types::SoundShapeEditor, om::editors::types::SoundSourceEditor, om::editors::types::CameraEditor, om::editors::types::ForceEditor, om::editors::types::ImageEditor, and om::editors::types::SoundEditor.
|
virtual |
Return a pointer to a GUI object that should be used as the mini view for this editor.
The default implementation returns NULL, indicating there is no mini view.
Reimplemented in om::editors::types::PrototypeEditor, om::editors::types::ConstraintEditor, om::editors::types::ForceFieldEditor, om::editors::types::GraphicsMaterialEditor, om::editors::types::GraphicsObjectEditor, om::editors::types::GraphicsShapeEditor, om::editors::types::PhysicsMaterialEditor, om::editors::types::PhysicsObjectEditor, om::editors::types::PhysicsShapeEditor, om::editors::types::ResourceGroupEditor, om::editors::types::ResourceSetEditor, om::editors::types::SceneEditor, om::editors::types::SequencerEditor, om::editors::types::SoundListenerEditor, om::editors::types::SoundMaterialEditor, om::editors::types::SoundObjectEditor, om::editors::types::SoundPluginEditor, om::editors::types::SoundShapeEditor, om::editors::types::SoundSourceEditor, om::editors::types::CameraEditor, om::editors::types::ForceEditor, om::editors::types::ImageEditor, and om::editors::types::SoundEditor.
|
inline |
Return a reference to the external services for this resource type editor.
|
virtual |
Set the external services for this resource type editor.
Reimplemented in om::editors::types::PrototypeEditor.
Return a reference to the delegate for this resource type editor.
|
virtual |
Set the delegate for this resource type editor.
|
virtual |
A method that should be called when a resource used by the editor is modified.
Reimplemented in om::editors::types::PrototypeEditor, om::editors::types::ResourceSetEditor, om::editors::types::SceneEditor, and om::editors::types::SequencerEditor.
|
virtual |
Get an opaque reference to the currently selected resource in the editor.
The method returns whether or not a valid resource was placed in the output parameter. The default implementation does nothing and returns FALSE.
|
virtual |
Return the number of input data connections there are for this editor's resource.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
virtual |
Return the number of output data connections there are for this editor's resource.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
virtual |
Return the resource type of the input data connection for this editor's resource at the specified index.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
virtual |
Return the resource type of the output data connection for this editor's resource at the specified index.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
virtual |
Return the name of the input data connection for this editor's resource at the specified index.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
virtual |
Return the name of the output data connection for this editor's resource at the specified index.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
virtual |
Return the icon of the input data connection for this editor's resource at the specified index.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
virtual |
Return the icon of the output data connection for this editor's resource at the specified index.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
virtual |
Construct and return a pointer to a new input connection at the specified index.
The connection should be inserted into the editor's local resource set.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
virtual |
Construct and return a pointer to a new output connection at the specified index.
The connection should be inserted into the editor's local resource set.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
virtual |
Construct and return a pointer to a new input connector at the specified index.
The connector should be inserted into the editor's local resource set.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
virtual |
Construct and return a pointer to a new output connector at the specified index.
The connector should be inserted into the editor's local resource set.
Reimplemented in om::editors::types::GraphicsObjectEditor, and om::editors::types::SoundPluginEditor.
|
protected |
An object that contains the external services for this editor.
|
protected |
An object that responds to events for this resource type editor.