SoOneShot - Online Linux Manual PageSection : 3
Updated : Mon Jan 25 2021
Source : Version 2.5.0
Note : Coin
NAMESoOneShot − The SoOneShot class is a timer that runs for a configurable time and then stops.
SYNOPSIS
#include <Inventor/engines/SoOneShot.h> Inherits SoEngine.
Public Typesenum Flags { RETRIGGERABLE =1, HOLD_FINAL =2 }
Public Member Functionsvirtual SoType getTypeId (void) const
virtual const SoFieldData * getFieldData (void) const
virtual const SoEngineOutputData * getOutputData (void) const
SoOneShot (void)
Static Public Member Functionsstatic SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass (void)
Public AttributesSoSFTime timeIn
SoSFTime duration
SoSFTrigger trigger
SoSFBitMask flags
SoSFBool disable
SoEngineOutput timeOut
SoEngineOutput isActive
SoEngineOutput ramp
Protected Member Functions~SoOneShot ()
Static Protected Member Functionsstatic const SoFieldData ** getInputDataPtr (void)
static const SoEngineOutputData ** getOutputDataPtr (void)
Additional Inherited Members
Detailed DescriptionThe SoOneShot class is a timer that runs for a configurable time and then stops.
Member Enumeration Documentation
enum SoOneShot::FlagsThere are two flags available: RETRIGGERABLE will cause the engine to restart at 0 if the SoOneShot::trigger field is activated during a run (otherwise the trigger is ignored during runs). HOLD_FINAL will make the engine outputs keep their values after a run, instead of resetting them.
Constructor & Destructor Documentation
SoOneShot::SoOneShot (void)Default constructor. References SoField::connectFrom(), disable, duration, flags, SoDB::getGlobalField(), isActive, ramp, timeIn, timeOut, trigger, and SbTime::zero().
SoOneShot::~SoOneShot () [protected]Destructor is protected to avoid explicit destruction.
Member Function Documentation
SoType SoOneShot::getTypeId (void) const [virtual]Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. Usage example: void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type
}
}For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. Implements SoBase.
const SoFieldData * SoOneShot::getFieldData (void) const [virtual]Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. Reimplemented from SoFieldContainer.
const SoEngineOutputData * SoOneShot::getOutputData (void) const [virtual]This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Implements SoEngine.
Member Data Documentation
SoSFTime SoOneShot::timeInInput time source. Connected by default to the realTime global field, but the application programmer is free to change this to any other time source. Referenced by SoOneShot().
SoSFTime SoOneShot::durationThe time the engine should run for when it is triggered. Defaults to 1 second. Referenced by SoOneShot().
SoSFTrigger SoOneShot::triggerA pulse on this input field starts the engine. Referenced by SoOneShot().
SoSFBitMask SoOneShot::flagsControl flags. See SoOneShot::Flags. Referenced by SoOneShot().
SoSFBool SoOneShot::disableSet to TRUE to disable the engine completely. Referenced by SoOneShot().
SoEngineOutput SoOneShot::timeOut(SoSFTime) Output time. Will run from 0 to the value of SoOneShot::duration. Referenced by SoOneShot().
SoEngineOutput SoOneShot::isActive(SoSFBool) TRUE while the engine is running, FALSE otherwise. Referenced by SoOneShot().
SoEngineOutput SoOneShot::ramp(SoSFFloat) Will run from 0 to 1 during the active period. Referenced by SoOneShot().
AuthorGenerated automatically by Doxygen for Coin from the source code. 0
Johanes Gumabo
Data Size : 26,378 byte
man-SoOneShot.3coin2Build : 2024-12-05, 20:55 :
Visitor Screen : x
Visitor Counter ( page / site ) : 3 / 181,714
Visitor ID : :
Visitor IP : 3.133.109.141 :
Visitor Provider : AMAZON-02 :
Provider Position ( lat x lon ) : 39.962500 x -83.006100 : x
Provider Accuracy Radius ( km ) : 1000 :
Provider City : Columbus :
Provider Province : Ohio , : ,
Provider Country : United States :
Provider Continent : North America :
Visitor Recorder : Version :
Visitor Recorder : Library :
Online Linux Manual Page : Version : Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page : Library : lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page : Library : lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base : Version : Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base : Library : lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36
Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .
If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.