Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Command Class Reference

Command base class from which all other commands are derived Derived classes must provide a unique constructor, destructor, and optionally provide a 'create_text' routine if the command has a text equivalent which should be echoed to a log file. More...

#include <Command.h>

Inheritance diagram for Command:

CmdAddAtomSelMacro CmdAnimDelete CmdAnimDir CmdAnimDup CmdAnimJump CmdAnimNewFrame CmdAnimNewNumFrames CmdAnimSkip CmdAnimSpeed CmdAnimStyle CmdAnimWriteFile CmdColorChange CmdColorItem CmdColorName CmdColorScaleColors CmdColorScaleMethod CmdColorScaleSettings CmdDelAtomSelMacro CmdDisplayAAOn CmdDisplayAOAmbient CmdDisplayAODirect CmdDisplayAOOn CmdDisplayAxes CmdDisplayBackgroundGradientOn CmdDisplayCacheMode CmdDisplayClip CmdDisplayCueDensity CmdDisplayCueEnd CmdDisplayCueMode CmdDisplayCueStart CmdDisplayCullingOn CmdDisplayDepthcueOn CmdDisplayDoFFNumber CmdDisplayDoFFocalDist CmdDisplayDoFOn CmdDisplayEyesep CmdDisplayFocallen CmdDisplayFPSOn CmdDisplayLightHL CmdDisplayLightMove CmdDisplayLightOn CmdDisplayLightRot CmdDisplayProj CmdDisplayRenderMode CmdDisplayScreenDistance CmdDisplayScreenHeight CmdDisplayShadowOn CmdDisplayStageLocation CmdDisplayStagePanels CmdDisplayStageSize CmdDisplayStereo CmdDisplayStereoSwap CmdIMDConnect CmdIMDCopyUnitCell CmdIMDRate CmdIMDSim CmdLabelAdd CmdLabelAddspring CmdLabelDelete CmdLabelShow CmdLabelTextFormat CmdLabelTextOffset CmdLabelTextSize CmdLabelTextThickness CmdMaterialAdd CmdMaterialChange CmdMaterialDefault CmdMaterialDelete CmdMaterialRename CmdMenuExtensionAdd CmdMenuExtensionRemove CmdMenuShow CmdMobileMode CmdMolActive CmdMolAddRep CmdMolBondsRecalc CmdMolCancel CmdMolChangeRep CmdMolChangeRepItem CmdMolColor CmdMolDelete CmdMolDeleteRep CmdMolDrawFrames CmdMolFix CmdMolLoad CmdMolMaterial CmdMolNew CmdMolNumPeriodic CmdMolOn CmdMolReanalyze CmdMolRename CmdMolRep CmdMolRepColorUpdate CmdMolRepSelUpdate CmdMolScaleMinmax CmdMolSelect CmdMolShowInstances CmdMolShowPeriodic CmdMolShowRep CmdMolSmoothRep CmdMolSSRecalc CmdMolTop CmdMolVolume CmdMouseMode CmdPluginUpdate CmdRender CmdRenderOption CmdResetView CmdRockOff CmdRockOn CmdRotate CmdRotMat CmdScale CmdSpaceballMode CmdToolAddDevice CmdToolCallback CmdToolChange CmdToolCreate CmdToolDelete CmdToolDeleteDevice CmdToolOffset CmdToolRep CmdToolScale CmdToolScaleForce CmdToolScaleSpring CmdTranslate InterpEvent PickEvent List of all members.

Public Types

enum  Cmdtype {
  ROTMAT, ROTATE, TRANSLATE, SCALE,
  ROCKON, ROCKOFF, STOPROT, ANIM_DIRECTION,
  ANIM_JUMP, ANIM_SKIP, ANIM_STYLE, ANIM_SPEED,
  ANIM_READ, ANIM_WRITE, ANIM_DELETE, ANIM_DUP,
  ANIM_NEW_FRAME, ANIM_NEW_NUM_FRAMES, ATOMSEL_ADDMACRO, ATOMSEL_DELMACRO,
  COLOR_NAME, COLOR_CHANGE, COLOR_SCALE_METHOD, COLOR_SCALE_SETTINGS,
  COLOR_SCALE_COLORS, COLOR_ADD_ITEM, DISP_BACKGROUNDGRADIENT, DISP_RESETVIEW,
  DISP_STEREO, DISP_STEREOSWAP, DISP_CACHEMODE, DISP_RENDERMODE,
  DISP_PROJ, DISP_EYESEP, DISP_FOCALLEN, DISP_LIGHT_ON,
  DISP_LIGHT_HL, DISP_LIGHT_ROT, DISP_LIGHT_MOVE, DISP_FPS,
  DISP_CLIP, DISP_DEPTHCUE, DISP_CULLING, DISP_ANTIALIAS,
  CMD_AXES, CMD_STAGE, DISP_SCRHEIGHT, DISP_SCRDIST,
  DISP_CUESTART, DISP_CUEEND, DISP_CUEDENSITY, DISP_CUEMODE,
  DISP_SHADOW, DISP_AO, DISP_AO_AMBIENT, DISP_AO_DIRECT,
  DISP_DOF, DISP_DOF_FNUMBER, DISP_DOF_FOCALDIST, IMD_ATTACH,
  IMD_SIM, IMD_RATE, IMD_COPYUNITCELL, INTERP_EVENT,
  LABEL_ADD, LABEL_ADDSPRING, LABEL_SHOW, LABEL_DELETE,
  LABEL_TEXTSIZE, LABEL_TEXTTHICKNESS, LABEL_TEXTOFFSET, LABEL_TEXTFORMAT,
  MATERIAL_ADD, MATERIAL_RENAME, MATERIAL_CHANGE, MATERIAL_DELETE,
  MATERIAL_DEFAULT, MENU_SHOW, MENU_TK_ADD, MENU_TK_REMOVE,
  MOL_NEW, MOL_DEL, MOL_ACTIVE, MOL_FIX,
  MOL_ON, MOL_TOP, MOL_SELECT, MOL_REP,
  MOL_COLOR, MOL_ADDREP, MOL_DELREP, MOL_MODREPITEM,
  MOL_MODREP, MOL_MATERIAL, MOL_CANCEL, MOL_REANALYZE,
  MOL_BONDRECALC, MOL_SSRECALC, MOL_REPSELUPDATE, MOL_REPCOLORUPDATE,
  MOL_DRAWFRAMES, MOL_SHOWPERIODIC, MOL_NUMPERIODIC, MOL_SCALEMINMAX,
  MOL_SMOOTHREP, MOL_VOLUME, MOL_RENAME, MOL_SHOWREP,
  MOUSE_MODE, PICK_EVENT, PLUGIN_UPDATE, RENDER,
  RENDER_OPTION, MOBILE_MODE, SPACEBALL_MODE, TOOL_CREATE,
  TOOL_CHANGE, TOOL_DELETE, TOOL_SCALE, TOOL_SCALE_FORCE,
  TOOL_SCALE_SPRING, TOOL_OFFSET, TOOL_REP, TOOL_ADD_DEVICE,
  TOOL_DELETE_DEVICE, TOOL_CALLBACK, TOTAL
}

Public Methods

 Command (Cmdtype newtype)
 constructor ... command type, max length of text command, UI id constructor for derived class should print text rep of this command to the stream 'cmdText'. More...

virtual ~Command ()
 destructor; free string spaced used for text rep of this command. More...

int has_text (Inform *str)
 if a Tcl text equivalent is available, write it into the given stream return whether this command has a text equivalent. More...

Cmdtype gettype ()
 return unique ID code of this command. More...


Protected Methods

virtual void create_text ()
 virtual function which is called when a text version of the command must be created to be printed to the console or a log file. More...


Protected Attributes

InformcmdText
 stream-based object to format text. More...


Detailed Description

Command base class from which all other commands are derived Derived classes must provide a unique constructor, destructor, and optionally provide a 'create_text' routine if the command has a text equivalent which should be echoed to a log file.

Definition at line 45 of file Command.h.


Member Enumeration Documentation

enum Command::Cmdtype
 

Enumeration values:
ROTMAT 
ROTATE 
TRANSLATE 
SCALE 
ROCKON 
ROCKOFF 
STOPROT 
ANIM_DIRECTION 
ANIM_JUMP 
ANIM_SKIP 
ANIM_STYLE 
ANIM_SPEED 
ANIM_READ 
ANIM_WRITE 
ANIM_DELETE 
ANIM_DUP 
ANIM_NEW_FRAME 
ANIM_NEW_NUM_FRAMES 
ATOMSEL_ADDMACRO 
ATOMSEL_DELMACRO 
COLOR_NAME 
COLOR_CHANGE 
COLOR_SCALE_METHOD 
COLOR_SCALE_SETTINGS 
COLOR_SCALE_COLORS 
COLOR_ADD_ITEM 
DISP_BACKGROUNDGRADIENT 
DISP_RESETVIEW 
DISP_STEREO 
DISP_STEREOSWAP 
DISP_CACHEMODE 
DISP_RENDERMODE 
DISP_PROJ 
DISP_EYESEP 
DISP_FOCALLEN 
DISP_LIGHT_ON 
DISP_LIGHT_HL 
DISP_LIGHT_ROT 
DISP_LIGHT_MOVE 
DISP_FPS 
DISP_CLIP 
DISP_DEPTHCUE 
DISP_CULLING 
DISP_ANTIALIAS 
CMD_AXES 
CMD_STAGE 
DISP_SCRHEIGHT 
DISP_SCRDIST 
DISP_CUESTART 
DISP_CUEEND 
DISP_CUEDENSITY 
DISP_CUEMODE 
DISP_SHADOW 
DISP_AO 
DISP_AO_AMBIENT 
DISP_AO_DIRECT 
DISP_DOF 
DISP_DOF_FNUMBER 
DISP_DOF_FOCALDIST 
IMD_ATTACH 
IMD_SIM 
IMD_RATE 
IMD_COPYUNITCELL 
INTERP_EVENT 
LABEL_ADD 
LABEL_ADDSPRING 
LABEL_SHOW 
LABEL_DELETE 
LABEL_TEXTSIZE 
LABEL_TEXTTHICKNESS 
LABEL_TEXTOFFSET 
LABEL_TEXTFORMAT 
MATERIAL_ADD 
MATERIAL_RENAME 
MATERIAL_CHANGE 
MATERIAL_DELETE 
MATERIAL_DEFAULT 
MENU_SHOW 
MENU_TK_ADD 
MENU_TK_REMOVE 
MOL_NEW 
MOL_DEL 
MOL_ACTIVE 
MOL_FIX 
MOL_ON 
MOL_TOP 
MOL_SELECT 
MOL_REP 
MOL_COLOR 
MOL_ADDREP 
MOL_DELREP 
MOL_MODREPITEM 
MOL_MODREP 
MOL_MATERIAL 
MOL_CANCEL 
MOL_REANALYZE 
MOL_BONDRECALC 
MOL_SSRECALC 
MOL_REPSELUPDATE 
MOL_REPCOLORUPDATE 
MOL_DRAWFRAMES 
MOL_SHOWPERIODIC 
MOL_NUMPERIODIC 
MOL_SCALEMINMAX 
MOL_SMOOTHREP 
MOL_VOLUME 
MOL_RENAME 
MOL_SHOWREP 
MOUSE_MODE 
PICK_EVENT 
PLUGIN_UPDATE 
RENDER 
RENDER_OPTION 
MOBILE_MODE 
SPACEBALL_MODE 
TOOL_CREATE 
TOOL_CHANGE 
TOOL_DELETE 
TOOL_SCALE 
TOOL_SCALE_FORCE 
TOOL_SCALE_SPRING 
TOOL_OFFSET 
TOOL_REP 
TOOL_ADD_DEVICE 
TOOL_DELETE_DEVICE 
TOOL_CALLBACK 
TOTAL 

Definition at line 50 of file Command.h.

Referenced by Command, gettype, and CommandQueue::runcommand.


Constructor & Destructor Documentation

Command::Command Cmdtype    newtype [inline]
 

constructor ... command type, max length of text command, UI id constructor for derived class should print text rep of this command to the stream 'cmdText'.

Definition at line 116 of file Command.h.

References Cmdtype.

virtual Command::~Command   [inline, virtual]
 

destructor; free string spaced used for text rep of this command.

Definition at line 120 of file Command.h.


Member Function Documentation

virtual void Command::create_text void    [inline, protected, virtual]
 

virtual function which is called when a text version of the command must be created to be printed to the console or a log file.

Reimplemented in CmdAnimDir.

Definition at line 108 of file Command.h.

Referenced by has_text.

Cmdtype Command::gettype   [inline]
 

return unique ID code of this command.

Definition at line 131 of file Command.h.

References Cmdtype.

Referenced by CommandQueue::runcommand.

int Command::has_text Inform   str [inline]
 

if a Tcl text equivalent is available, write it into the given stream return whether this command has a text equivalent.

Definition at line 124 of file Command.h.

References create_text.

Referenced by VMDCollab::act_on_command, and UIText::act_on_command.


Member Data Documentation

Inform* Command::cmdText [protected]
 

stream-based object to format text.

Definition at line 104 of file Command.h.

Referenced by CmdToolCallback::create_text, CmdToolRep::create_text, CmdToolDeleteDevice::create_text, CmdToolAddDevice::create_text, CmdToolOffset::create_text, CmdToolScaleSpring::create_text, CmdToolScaleForce::create_text, CmdToolScale::create_text, CmdToolDelete::create_text, CmdToolChange::create_text, CmdToolCreate::create_text, CmdRockOff::create_text, CmdRockOn::create_text, CmdScale::create_text, CmdTranslate::create_text, CmdRotate::create_text, CmdRotMat::create_text, CmdRender::create_text, CmdPluginUpdate::create_text, CmdMolShowRep::create_text, CmdMolSmoothRep::create_text, CmdMolDrawFrames::create_text, CmdMolScaleMinmax::create_text, CmdMolShowInstances::create_text, CmdMolNumPeriodic::create_text, CmdMolShowPeriodic::create_text, CmdMolRename::create_text, CmdMolSSRecalc::create_text, CmdMolBondsRecalc::create_text, CmdMolReanalyze::create_text, CmdMolDeleteRep::create_text, CmdMolRepColorUpdate::create_text, CmdMolRepSelUpdate::create_text, CmdMolChangeRepItem::create_text, CmdMolChangeRep::create_text, CmdMolAddRep::create_text, CmdMolMaterial::create_text, CmdMolColor::create_text, CmdMolRep::create_text, CmdMolSelect::create_text, CmdMolTop::create_text, CmdMolOn::create_text, CmdMolFix::create_text, CmdMolActive::create_text, CmdMolCancel::create_text, CmdMolDelete::create_text, CmdMolLoad::create_text, CmdMenuShow::create_text, CmdMaterialDefault::create_text, CmdMaterialDelete::create_text, CmdMaterialChange::create_text, CmdMaterialRename::create_text, CmdMaterialAdd::create_text, CmdLabelTextFormat::create_text, CmdLabelTextOffset::create_text, CmdLabelTextThickness::create_text, CmdLabelTextSize::create_text, CmdLabelDelete::create_text, CmdLabelShow::create_text, CmdLabelAdd::create_text, CmdLabelAddspring::create_text, CmdIMDCopyUnitCell::create_text, CmdIMDRate::create_text, CmdIMDSim::create_text, CmdIMDConnect::create_text, CmdDisplayLightMove::create_text, CmdDisplayLightRot::create_text, CmdDisplayLightHL::create_text, CmdDisplayLightOn::create_text, CmdDisplayStageSize::create_text, CmdDisplayStagePanels::create_text, CmdDisplayStageLocation::create_text, CmdDisplayAxes::create_text, CmdDisplayDoFFocalDist::create_text, CmdDisplayDoFFNumber::create_text, CmdDisplayDoFOn::create_text, CmdDisplayAODirect::create_text, CmdDisplayAOAmbient::create_text, CmdDisplayAOOn::create_text, CmdDisplayShadowOn::create_text, CmdDisplayCueDensity::create_text, CmdDisplayCueEnd::create_text, CmdDisplayCueStart::create_text, CmdDisplayCueMode::create_text, CmdDisplayClip::create_text, CmdDisplayFPSOn::create_text, CmdDisplayBackgroundGradientOn::create_text, CmdDisplayCullingOn::create_text, CmdDisplayDepthcueOn::create_text, CmdDisplayAAOn::create_text, CmdDisplayScreenDistance::create_text, CmdDisplayScreenHeight::create_text, CmdDisplayFocallen::create_text, CmdDisplayEyesep::create_text, CmdDisplayProj::create_text, CmdDisplayRenderMode::create_text, CmdDisplayCacheMode::create_text, CmdDisplayStereoSwap::create_text, CmdDisplayStereo::create_text, CmdResetView::create_text, CmdColorScaleColors::create_text, CmdColorItem::create_text, CmdColorScaleSettings::create_text, CmdColorScaleMethod::create_text, CmdColorChange::create_text, CmdColorName::create_text, CmdAnimDup::create_text, CmdAnimDelete::create_text, CmdAnimWriteFile::create_text, CmdAnimSpeed::create_text, CmdAnimSkip::create_text, CmdAnimJump::create_text, CmdAnimStyle::create_text, and CmdAnimDir::create_text.


The documentation for this class was generated from the following file:
Generated on Fri Dec 6 02:46:56 2024 for VMD (current) by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002