OSSIM - Open Source Software Image Map  Version 1.9.0 (20180803)
Public Member Functions | Protected Attributes | List of all members
ossimViewController Class Reference

#include <ossimViewController.h>

Inheritance diagram for ossimViewController:
ossimSource ossimConnectableObject ossimErrorStatusInterface ossimObject ossimListenerManager ossimPropertyInterface ossimReferenced ossimMapViewController

Public Member Functions

 ossimViewController ()
 
 ossimViewController (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListFixedFlag=true, bool outputListFixedFlag=false)
 
virtual ~ossimViewController ()
 
virtual ossimString getShortName () const
 
virtual ossimString getLongName () const
 
virtual bool propagateView ()
 
virtual bool setView (ossimObject *object)
 
virtual ossimObjectgetView ()
 
virtual const ossimObjectgetView () const
 
virtual bool canConnectMyInputTo (ossim_int32 index, const ossimConnectableObject *obj) const
 required to be overriden by derived classes More...
 
virtual const ossimObjectfindFirstViewOfType (RTTItypeid typeId) const
 
- Public Member Functions inherited from ossimSource
 ossimSource (ossimObject *owner=0)
 
 ossimSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)
 
virtual ~ossimSource ()
 
virtual bool isSourceEnabled () const
 
virtual void enableSource ()
 
virtual void disableSource ()
 
virtual bool getEnableFlag () const
 
virtual void setEnableFlag (bool flag)
 
virtual bool isInitialized () const
 
virtual void setInitializedFlag (bool flag)
 
virtual void initialize ()
 
virtual void setProperty (ossimRefPtr< ossimProperty > property)
 
virtual ossimRefPtr< ossimPropertygetProperty (const ossimString &name) const
 
virtual void getPropertyNames (std::vector< ossimString > &propertyNames) const
 
virtual bool saveState (ossimKeywordlist &kwl, const char *prefix=0) const
 
virtual bool loadState (const ossimKeywordlist &kwl, const char *prefix=0)
 
virtual std::ostream & print (std::ostream &out) const
 Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...
 
- Public Member Functions inherited from ossimConnectableObject
 ossimConnectableObject (ossimObject *owner=0)
 Base constructor of this object. More...
 
 ossimConnectableObject (ossimObject *owner, ossim_int32 inputListSize, ossim_int32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)
 
virtual ~ossimConnectableObject ()
 
void setId (const ossimId &id)
 All connectable objects will have id's. More...
 
const ossimIdgetId () const
 Will allow us to get this object's id. More...
 
const ossimObjectgetOwner () const
 Fetches the current owner, most likely a container but not limited to one. More...
 
virtual void changeOwner (ossimObject *owner)
 Permits changing the object's owner. More...
 
virtual void setDescription (const ossimString &description)
 
virtual ossimString getDescription () const
 
virtual bool isConnected (ossimConnectableObjectDirectionType direction=CONNECTABLE_DIRECTION_INPUT) const
 will check the direction specified to see if all slots are full. More...
 
 OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findConnectableObject(const ossimId &id))
 
 OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(RTTItypeid typeId, ossimConnectableObjectDirectionType directionType, bool recurse=true))
 
 OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(const ossimString &obj, ossimConnectableObjectDirectionType directionType, bool recurse=true))
 
 OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findInputObjectOfType(const ossimString &className))
 
virtual ossim_int32 findInputIndex (const ossimConnectableObject *object)
 Return a valid index of the input list if the passed in object is found else return -1. More...
 
virtual ossim_int32 findInputIndex (const ossimId &id)
 Return a valid index of the input list if the passed id is found else return -1. More...
 
virtual ossim_int32 findOutputIndex (const ossimConnectableObject *object)
 Return a valid index of the output list if the passed in object is found else return -1. More...
 
virtual ossim_int32 findOutputIndex (const ossimId &id)
 Return a valid index of the output list if the passed in object is found else return -1. More...
 
virtual ossim_int32 getMyInputIndexToConnectTo (ossimConnectableObject *object) const
 Should return the first available index to connect to. More...
 
virtual ossim_int32 getMyOutputIndexToConnectTo (ossimConnectableObject *object) const
 Should return the first available index to connect to. More...
 
virtual bool canConnectMyOutputTo (ossim_int32 myOutputIndex, const ossimConnectableObject *object) const
 default implementation is to allow anyone to connect to us. More...
 
virtual void disconnect (ossimConnectableObject *object=0)
 Will disconnect the object passed in. More...
 
virtual void disconnect (const ossimId &id)
 Will disconnect the object passed in. More...
 
virtual ossimRefPtr< ossimConnectableObjectdisconnectMyInput (ossim_int32 inputIndex, bool disconnectOutputFlag=true, bool createEventFlag=true)
 Will disconnect the object at the given input index and generate a connection event. More...
 
virtual void disconnectMyInput (ossimConnectableObject *input, bool disconnectOutputFlag=true, bool createEventFlag=true)
 Finds the index of the passed in input and calls disconnectMyInput(inputIndex, disconnectOutputFlag, createEventFlag);. More...
 
virtual void disconnectMyInputs (ConnectableObjectList &inputList, bool disconnectOutputFlag=true, bool createEventFlag=true)
 
virtual ossimRefPtr< ossimConnectableObjectdisconnectMyOutput (ossim_int32 outputIndex, bool disconnectInputFlag=true, bool createEventFlag=true)
 Will disconnect the object at the given output index and generate a connection event. More...
 
virtual void disconnectMyOutput (ossimConnectableObject *output, bool disconnectInputFlag=true, bool createEventFlag=true)
 Will disconnect the output object. More...
 
virtual void disconnectMyOutputs (ConnectableObjectList &outputList, bool disconnectOutputFlag=true, bool createEventFlag=true)
 
virtual void disconnectAllInputs ()
 Will disconnect all of the input objects. More...
 
virtual void disconnectAllOutputs ()
 Will disconnect all of the output objects. More...
 
virtual ossim_int32 connectMyInputTo (ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
 Will try to connect this objects input to the passed in object. More...
 
virtual ossim_int32 connectMyInputTo (ossim_int32 inputIndex, ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
 Will connect the specified input to the passed in object. More...
 
virtual bool connectMyInputTo (ConnectableObjectList &inputList, bool makeOutputConnection=true, bool createEventFlag=true)
 
virtual ossim_int32 connectMyOutputTo (ossimConnectableObject *outputObject, bool makeInputConnection=true, bool createEventFlag=true)
 Will try to connect this objects output to the passed in object. More...
 
virtual bool connectMyOutputTo (ConnectableObjectList &outputList, bool makeInputConnection=true, bool createEventFlag=true)
 
virtual bool connectInputList (ConnectableObjectList &inputList)
 Will disconnect itself from all inputs and reset to the passed in input list. More...
 
virtual bool connectOutputList (ConnectableObjectList &outputList)
 Will disconnect itself from all outputs and reset to the passed in output list. More...
 
virtual ossim_uint32 getNumberOfInputs () const
 Returns the number of input objects. More...
 
virtual ossim_uint32 getNumberOfOutputs () const
 Return the number of output objects. More...
 
ossimConnectableObjectgetInput (ossim_uint32 index=0)
 returns the object at the specified index. More...
 
const ossimConnectableObjectgetInput (ossim_uint32 index=0) const
 returns the object at the specified index. More...
 
ossimConnectableObjectgetOutput (ossim_uint32 index=0)
 returns the object at the specified index. More...
 
const ossimConnectableObjectgetOutput (ossim_uint32 index=0) const
 returns the object at the specified index. More...
 
virtual void setNumberOfInputs (ossim_int32 numberOfInputs)
 Will set the number of inputs. More...
 
virtual bool getInputListIsFixedFlag () const
 
virtual bool getOutputListIsFixedFlag () const
 
virtual void setNumberOfOutputs (ossim_int32 numberOfInputs)
 Will set the number of outputs. More...
 
const ConnectableObjectListgetInputList () const
 
const ConnectableObjectListgetOutputList () const
 
ConnectableObjectListgetInputList ()
 
ConnectableObjectListgetOutputList ()
 
 OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const RTTItypeid &typeInfo, bool recurse=true))
 
 OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const ossimString &className, bool recurse=true))
 
virtual void propagateEventToOutputs (ossimEvent &event)
 
virtual void propagateEventToInputs (ossimEvent &event)
 
virtual void setProperty (const ossimString &name, const ossimString &value)
 
virtual ossim_uint32 saveStateOfAllInputs (ossimKeywordlist &kwl, bool saveThisStateFlag=true, ossim_uint32 objectIndex=1, const char *prefix=0) const
 Save the state of all inputs to a keyword list. More...
 
virtual bool fillContainer (ossimConnectableContainer &container)
 Inserts this object and all of its children and inputs into the container provided. More...
 
bool moveInputUp (const ossimId &id)
 Moves the input connection matching id up one in the connection list. More...
 
bool moveInputDown (const ossimId &id)
 Moves the input connection matching id down one in the connection list. More...
 
bool moveInputToTop (const ossimId &id)
 Moves the input connection matching id to the top of the connection list. More...
 
bool moveInputToBottom (const ossimId &id)
 Moves the input connection matching id to the bottom of the connection list. More...
 
virtual void accept (ossimVisitor &visitor)
 We will add a visitor interface for all connectable objects. More...
 
- Public Member Functions inherited from ossimObject
 ossimObject ()
 
virtual ~ossimObject ()
 
virtual ossimObjectdup () const
 
virtual ossimString getClassName () const
 
virtual RTTItypeid getType () const
 
virtual bool canCastTo (ossimObject *obj) const
 
virtual bool canCastTo (const RTTItypeid &id) const
 
virtual bool canCastTo (const ossimString &parentClassName) const
 
virtual bool isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
 
- Public Member Functions inherited from ossimReferenced
 ossimReferenced ()
 
 ossimReferenced (const ossimReferenced &)
 
ossimReferencedoperator= (const ossimReferenced &)
 
void ref () const
 increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
void unref () const
 decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
 
void unref_nodelete () const
 decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
 
int referenceCount () const
 
- Public Member Functions inherited from ossimListenerManager
 ossimListenerManager ()
 
virtual ~ossimListenerManager ()
 
virtual void fireEvent (ossimEvent &event)
 
virtual bool addListener (ossimListener *listener)
 
virtual bool removeListener (ossimListener *listener)
 
virtual bool findListener (ossimListener *listener)
 
- Public Member Functions inherited from ossimPropertyInterface
 ossimPropertyInterface ()
 
virtual ~ossimPropertyInterface ()
 
virtual ossimString getPropertyValueAsString (const ossimString &name) const
 
void getPropertyList (std::vector< ossimRefPtr< ossimProperty > > &propertyList) const
 
void setProperties (std::vector< ossimRefPtr< ossimProperty > > &propertyList)
 
- Public Member Functions inherited from ossimErrorStatusInterface
 ossimErrorStatusInterface ()
 
virtual ~ossimErrorStatusInterface ()
 
virtual ossimErrorCode getErrorStatus () const
 
virtual ossimString getErrorStatusString () const
 
virtual void setErrorStatus (ossimErrorCode error_status) const
 
virtual void setErrorStatus () const
 
virtual void clearErrorStatus () const
 
bool hasError () const
 

Protected Attributes

ossimRefPtr< ossimObjecttheView
 
- Protected Attributes inherited from ossimSource
bool theEnableFlag
 
bool theInitializedFlag
 
- Protected Attributes inherited from ossimConnectableObject
ossimId theId
 
ossimString theDescription
 
ossimObjecttheOwner
 
bool theInputListIsFixedFlag
 Indicates whether the theInputObjectList is fixed. More...
 
bool theOutputListIsFixedFlag
 Indicates whether the theOutputObjectList is fixed. More...
 
ConnectableObjectList theInputObjectList
 Holds a list of input objects. More...
 
ConnectableObjectList theOutputObjectList
 Holds a list of output objects. More...
 
- Protected Attributes inherited from ossimListenerManager
std::list< ossimListener * > theListenerList
 
bool theEnabledFlag
 
std::list< ossimListener * > theDelayedAdd
 
std::list< ossimListener * > theDelayedRemove
 
bool theFireEventFlag
 
- Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode theErrorStatus
 

Additional Inherited Members

- Public Types inherited from ossimConnectableObject
enum  ossimConnectableObjectDirectionType { CONNECTABLE_DIRECTION_NONE = 0, CONNECTABLE_DIRECTION_INPUT = 1, CONNECTABLE_DIRECTION_OUTPUT = 2 }
 
typedef std::vector< ossimRefPtr< ossimConnectableObject > > ConnectableObjectList
 
- Protected Member Functions inherited from ossimSource
 ossimSource (const ossimSource &rhs)
 
const ossimSourceoperator= (const ossimSource &rhs)
 
- Protected Member Functions inherited from ossimConnectableObject
ossimConnectableObjectfindObjectOfType (ConnectableObjectList *connectableList, ossimVisitor &visitor)
 
- Protected Member Functions inherited from ossimReferenced
virtual ~ossimReferenced ()
 
- Protected Member Functions inherited from ossimListenerManager
 ossimListenerManager (const ossimListenerManager &rhs)
 

Detailed Description

All view sources will derive from this class. For example we can have a mapped view or Perspective view of the scene being rendered. All sources within the containers are expected to derive from the view interface.

Definition at line 20 of file ossimViewController.h.

Constructor & Destructor Documentation

◆ ossimViewController() [1/2]

ossimViewController::ossimViewController ( )

Definition at line 12 of file ossimViewController.cpp.

References theView.

13  :
14  ossimSource((ossimObject*)NULL, 0, 0, true, false)
15 {
16  theView = NULL;
17 }
ossimRefPtr< ossimObject > theView
ossimSource(ossimObject *owner=0)

◆ ossimViewController() [2/2]

ossimViewController::ossimViewController ( ossimObject owner,
ossim_uint32  inputListSize,
ossim_uint32  outputListSize,
bool  inputListFixedFlag = true,
bool  outputListFixedFlag = false 
)

Definition at line 19 of file ossimViewController.cpp.

References theView.

24  :
25  ossimSource(owner,
26  inputListSize,
27  outputListSize,
28  inputListFixedFlag,
29  outputListFixedFlag)
30 {
31  theView = NULL;
32 }
ossimRefPtr< ossimObject > theView
ossimSource(ossimObject *owner=0)

◆ ~ossimViewController()

ossimViewController::~ossimViewController ( )
virtual

Definition at line 34 of file ossimViewController.cpp.

References theView.

35 {
36  theView = 0;
37 }
ossimRefPtr< ossimObject > theView

Member Function Documentation

◆ canConnectMyInputTo()

bool ossimViewController::canConnectMyInputTo ( ossim_int32  myInputIndex,
const ossimConnectableObject object 
) const
virtual

required to be overriden by derived classes

Implements ossimConnectableObject.

Definition at line 49 of file ossimViewController.cpp.

51 {
52  return false;
53 }

◆ findFirstViewOfType()

const ossimObject * ossimViewController::findFirstViewOfType ( RTTItypeid  typeId) const
virtual

Definition at line 118 of file ossimViewController.cpp.

References RTTItypeid::can_cast(), ossimConnectableContainerInterface::findAllObjectsOfType(), ossimObject::getType(), ossimViewInterface::getView(), PTR_CAST, STATIC_TYPE_INFO, and ossimConnectableObject::theOwner.

Referenced by ossimMapViewController::changeOwner(), and ossimMapViewController::ossimMapViewController().

119 {
121  theOwner);
122  if(inter)
123  {
124  RTTItypeid viewInterfaceType = STATIC_TYPE_INFO(ossimViewInterface);
126  true);
127  if(result.size() > 0)
128  {
129  ossim_uint32 index = 0;
130 
131  for(index = 0; index < result.size(); ++index)
132  {
133 
134  ossimViewInterface* viewInterface = PTR_CAST(ossimViewInterface, result[index].get());
135 
136  if(viewInterface)
137  {
138  if(viewInterface->getView())
139  {
140  if(typeId.can_cast(viewInterface->getView()->getType()))
141  {
142  return viewInterface->getView();
143  }
144  }
145  }
146  }
147  }
148  }
149 
150  return (ossimObject*)NULL;
151 }
virtual ossimConnectableObject::ConnectableObjectList findAllObjectsOfType(const RTTItypeid &typeInfo, bool recurse=true)=0
int can_cast(RTTItypeid) const
Definition: ossimRtti.h:259
virtual RTTItypeid getType() const
Definition: ossimObject.cpp:69
std::vector< ossimRefPtr< ossimConnectableObject > > ConnectableObjectList
unsigned int ossim_uint32
#define STATIC_TYPE_INFO(T)
Definition: ossimRtti.h:319
#define PTR_CAST(T, p)
Definition: ossimRtti.h:321
virtual ossimObject * getView()=0

◆ getLongName()

ossimString ossimViewController::getLongName ( ) const
virtual

Reimplemented from ossimObject.

Reimplemented in ossimMapViewController.

Definition at line 44 of file ossimViewController.cpp.

45 {
46  return ossimString("View controller");
47 }

◆ getShortName()

ossimString ossimViewController::getShortName ( ) const
virtual

Reimplemented from ossimObject.

Reimplemented in ossimMapViewController.

Definition at line 39 of file ossimViewController.cpp.

40 {
41  return ossimString("View");
42 }

◆ getView() [1/2]

ossimObject * ossimViewController::getView ( )
virtual

Definition at line 108 of file ossimViewController.cpp.

References ossimRefPtr< T >::get(), and theView.

Referenced by ossimMapViewController::saveState().

109 {
110  return theView.get();
111 }
ossimRefPtr< ossimObject > theView

◆ getView() [2/2]

const ossimObject * ossimViewController::getView ( ) const
virtual

Definition at line 113 of file ossimViewController.cpp.

References ossimRefPtr< T >::get(), and theView.

114 {
115  return theView.get();
116 }
ossimRefPtr< ossimObject > theView

◆ propagateView()

bool ossimViewController::propagateView ( )
virtual

Definition at line 55 of file ossimViewController.cpp.

References ossimConnectableContainerInterface::findAllObjectsOfType(), ossimRefPtr< T >::get(), ossimObject::getClassName(), ossimNotify(), ossimNotifyLevel_FATAL, PTR_CAST, ossimViewInterface::setView(), STATIC_TYPE_INFO, ossimConnectableObject::theOwner, and theView.

Referenced by ossimMapViewController::changeOwner().

56 {
57  bool returnResult = true;
58  if(!theOwner)
59  {
60  ossimNotify(ossimNotifyLevel_FATAL) << "FATAL: " << getClassName() << "::propagateView(), has no owner! We must find all views to set.\n";
61  return false;
62  }
64  theOwner);
65  if(inter)
66  {
69  true);
70  if(result.size() > 0)
71  {
72  ossim_uint32 index = 0;
73 
74  // first set all views then update all outputs
75  //
76  for(index = 0; index < result.size(); ++index)
77  {
78  ossimViewInterface* viewInterface = PTR_CAST(ossimViewInterface, result[index].get());
79 
80  if(viewInterface)
81  {
82  if(!viewInterface->setView(theView.get()))
83  {
84  returnResult = false;
85  }
86  }
87  }
88 
89  for(index = 0; index < result.size(); ++index)
90  {
91  ossimPropertyEvent event(result[index].get());
92  result[index]->fireEvent(event);
93  result[index]->propagateEventToOutputs(event);
94  }
95  }
96  }
97 
98  return returnResult;
99 }
ossimRefPtr< ossimObject > theView
virtual ossimConnectableObject::ConnectableObjectList findAllObjectsOfType(const RTTItypeid &typeInfo, bool recurse=true)=0
virtual ossimString getClassName() const
Definition: ossimObject.cpp:64
std::vector< ossimRefPtr< ossimConnectableObject > > ConnectableObjectList
unsigned int ossim_uint32
#define STATIC_TYPE_INFO(T)
Definition: ossimRtti.h:319
#define PTR_CAST(T, p)
Definition: ossimRtti.h:321
virtual bool setView(ossimObject *baseObject)=0
OSSIMDLLEXPORT std::ostream & ossimNotify(ossimNotifyLevel level=ossimNotifyLevel_WARN)

◆ setView()

bool ossimViewController::setView ( ossimObject object)
virtual

Reimplemented in ossimMapViewController.

Definition at line 101 of file ossimViewController.cpp.

References theView.

Referenced by ossimMapViewController::setView().

102 {
103  theView = object;
104 
105  return true;
106 }
ossimRefPtr< ossimObject > theView

Member Data Documentation

◆ theView

ossimRefPtr<ossimObject> ossimViewController::theView
protected

The documentation for this class was generated from the following files: