GRE::VIEWABLE Class Reference
Base class for objects that can have "views" (GRE::LAYOUT, GRE::GROUP). More...
#include <gre/viewable.h>
Detailed Description
Base class for objects that can have "views" (GRE::LAYOUT, GRE::GROUP).
Constructor & Destructor Documentation
| virtual GRE::VIEWABLE::~VIEWABLE | ( | ) | [virtual] |
Destructor.
| GRE::VIEWABLE::VIEWABLE | ( | OBJECT::TYPE | type, | |
| VIEWABLE * | container | |||
| ) | [explicit, protected] |
Constructor.
- Parameters:
-
type Object type container Containing viewable
Member Function Documentation
| void GRE::VIEWABLE::Clear | ( | ) |
Clear contents of viewable, resetting to default state.
| void GRE::VIEWABLE::ClearSaveLocation | ( | ) | [inline] |
Clear save location specification.
| ERRVALUE GRE::VIEWABLE::ControlScriptEdit | ( | MDLGPARENT | dlgparent | ) |
| ERRVALUE GRE::VIEWABLE::ControlScriptInitialize | ( | ) | [protected] |
| void GRE::VIEWABLE::DestroyAllViews | ( | ) |
Destroy all views of this object.
| ERRVALUE GRE::VIEWABLE::DrawAllViews | ( | GRE::DRAWCONDITION | condition = GRE::DRAWCONDITION_Always |
) | [inline] |
Draw all views of this object.
| virtual GRE::LAYER* GRE::VIEWABLE::FindLayerByID | ( | UINT32 | LayerID | ) | const [pure virtual] |
Find layer using unique ID.
Implemented in GRE::GROUP, and GRE::LAYOUT.
| GRE::LAYER* GRE::VIEWABLE::GetActiveLayer | ( | ) | const [inline] |
Get active layer for viewable.
| MAINSCRIPT& GRE::VIEWABLE::GetControlScript | ( | ) | [inline] |
Get reference to "display control script".
| double GRE::VIEWABLE::GetDesignScale | ( | ) | const [inline] |
Get 'design scale' for layout or group.
| GRE::HIGHLIGHTMODE GRE::VIEWABLE::GetElemHighlightMode | ( | ) | const [inline] |
Get element highlighting mode.
| const DRECT2D& GRE::VIEWABLE::GetExtents | ( | ) | const [inline] |
Get overall viewable extents.
| GRE::VIEW* GRE::VIEWABLE::GetFirstView | ( | ) | const |
Get first view of this object.
- Returns:
- Pointer to view or NULL if no views of this object.
To loop through all views for an object use this method to get the first view. Then use the GRE::VIEW::GetNext() to obtain the next view, checking for NULL as shown:
for (GRE::VIEW *view = object->GetFirstView(); (view != 0); view = view->GetNext()) { ... }
| virtual void GRE::VIEWABLE::GetFullName | ( | MISTRING & | name | ) | const [pure virtual] |
| UINT8 GRE::VIEWABLE::GetIniIndex | ( | ) | const [inline, protected] |
Get unique index for building Ini name.
| const char* GRE::VIEWABLE::GetIniName | ( | ) | const [inline] |
Get name of object to use in Ini file access.
| GRE::MACROSCRIPTLIST& GRE::VIEWABLE::GetMacroScriptList | ( | ) | [inline] |
Get MacroScript list.
| double GRE::VIEWABLE::GetMaxScaleVisibleAny | ( | ) | const [inline] |
Get maximum visible scale for any item in viewable.
- Returns:
- 0 if at least one item has no maximum scale set.
| double GRE::VIEWABLE::GetMinScaleVisibleAny | ( | ) | const [inline] |
Get minimum visible scale for any item in viewable.
| virtual UINT32 GRE::VIEWABLE::GetNextLayerID | ( | ) | const [pure virtual] |
Get next available unique ID.
Implemented in GRE::GROUP, and GRE::LAYOUT.
| void GRE::VIEWABLE::GetNoRenderLayerList | ( | MILIST< GRE::LAYER * > & | LayerList | ) |
Get list of layers that can't be rendered.
| const FILEPATH& GRE::VIEWABLE::GetSaveFilePath | ( | ) | const [inline] |
Get path to file where viewable saved.
| const RVC::OBJITEM& GRE::VIEWABLE::GetSaveObjItem | ( | ) | const [inline] |
Get object item reference to save location.
Compute dimensions of object based on scale and georeference.
- Parameters:
-
sizemeters Size returned in meters
Implemented in GRE::GROUP, and GRE::LAYOUT.
| GRE::TOOLSCRIPTLIST& GRE::VIEWABLE::GetToolScriptList | ( | ) | [inline] |
Get ToolScript list.
| VIEWABLE* GRE::VIEWABLE::GetTopViewable | ( | ) |
Get topmost containing viewable (non-const).
| const VIEWABLE* GRE::VIEWABLE::GetTopViewable | ( | ) | const |
Get topmost containing viewable (const).
| GRE::VIEW* GRE::VIEWABLE::GetView | ( | int | ViewNum | ) | const |
Get view of this object given view number.
- Returns:
- Pointer to view or NULL if no matching view.
| virtual bool GRE::VIEWABLE::HasLayers | ( | ) | const [pure virtual] |
Determine if object has any layers.
Implemented in GRE::GROUP, and GRE::LAYOUT.
| bool GRE::VIEWABLE::HasSaveLocation | ( | ) | const |
Determine if save location has been specified.
| bool GRE::VIEWABLE::IsModified | ( | ) | const [inline] |
Determine if changes have been made since last save.
| bool GRE::VIEWABLE::IsTopViewable | ( | ) | const [inline] |
Determine if is topmost viewable.
| ERRVALUE GRE::VIEWABLE::RenderToRaster | ( | RVC::OBJITEM & | objitem, | |
| const PARM_RENDERTORASTER & | parm | |||
| ) |
Render to raster.
- Parameters:
-
objitem Target object parm Rendering parameters
| void GRE::VIEWABLE::ResetModified | ( | ) | [inline] |
Reset "is modified" status to "false".
| static const SERIALIZERITEM* GRE::VIEWABLE::SerialGetItemDef | ( | SERIALIZER & | ) | [inline, static, protected] |
Get serialization item definition array.
| void GRE::VIEWABLE::SetDesignScale | ( | double | DesignScale, | |
| bool | notify = true | |||
| ) | [inline] |
Set 'design scale' for layout or group.
- Parameters:
-
DesignScale Design scale to set notify Send notification if changed
| void GRE::VIEWABLE::SetElemHighlightMode | ( | GRE::HIGHLIGHTMODE | HighlightMode | ) |
Set element highlighting mode.
| void GRE::VIEWABLE::SetIniBase | ( | const char * | name | ) |
Set base name of object for use in Ini file acces.
| void GRE::VIEWABLE::SetIniIndex | ( | UINT8 | IniIndex | ) | [protected] |
Set index for building Ini name.
| void GRE::VIEWABLE::SetMacroScriptList | ( | const GRE::MACROSCRIPTLIST & | ScriptList | ) |
Set MacroScript list.
| void GRE::VIEWABLE::SetSaveFilePath | ( | const FILEPATH & | SaveFilePath | ) |
Set path to file where viewable saved.
Also resets object such that expects to save to non-RVC file.
| void GRE::VIEWABLE::SetSaveObjItem | ( | const RVC::OBJITEM & | SaveObjItem | ) | [inline] |
Set object item reference to save location.
| void GRE::VIEWABLE::SetToolScriptList | ( | const GRE::TOOLSCRIPTLIST & | ScriptList | ) |
Set ToolScript list.
| static void GRE::VIEWABLE::SMLClassInstall | ( | SMLCONTEXT * | context | ) | [static] |
Install SML class, called by internal SML function.
Reimplemented in GRE::GROUP, and GRE::LAYOUT.
| static const SERIALIZERITEM* GRE::VIEWABLE::TemplateGetItemDef | ( | ) | [static, protected] |
Get serialization item definition array.
| void GRE::VIEWABLE::TreeViewGetAll | ( | SIMPLE_ARRAY< GRE::CTRL_TREEVIEW * > & | TreeViewPtrs | ) | const |
Get all TreeViews which may contain this viewable.
| void GRE::VIEWABLE::TreeViewSetPtr | ( | GRE::CTRL_TREEVIEW * | pTreeView | ) | [inline] |
Set TreeView pointer.
Used by GRE CTRL_TREEVIEW implementation, should not be called directly.
| void GRE::VIEWABLE::UnhighlightAllElements | ( | bool | redrawviews | ) | [inline] |
Unhighlight all "marked" elements.
| void GRE::VIEWABLE::UpdateViewScriptUI | ( | ) |
Update user interface for changes to view scripts.
Member Data Documentation
bool GRE::VIEWABLE::m_IsModified [protected] |
Changes have been made since last save.
The documentation for this class was generated from the following file:
- gre/viewable.h
