SoOneShot Class

SoOneShot Class

Timer that runs for a pre-set amount of time.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.EnginesSoEngine
            OIV.Inventor.EnginesSoOneShot

Namespace: OIV.Inventor.Engines
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)

Syntax

C++

Copy

public class SoOneShot : SoEngine

Public Class SoOneShot
	Inherits SoEngine

public ref class SoOneShot : public SoEngine

type SoOneShot =  
    class
        inherit SoEngine
    end

The SoOneShot type exposes the following members.

Constructors

	Name	Description
	SoOneShot	Constructor.

Top

Methods

	Name	Description
	Copy	Creates and returns an exact copy of the engine. (Inherited from SoEngine.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetOutput	Returns a reference to the engine output with the given name. (Inherited from SoEngine.)
	GetOutputName	Returns (in outputName) the name of the engine output (output). (Inherited from SoEngine.)
	GetOutputs	Returns a list of outputs in this engine. (Inherited from SoEngine.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Set	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. (Inherited from SoFieldContainer.)
	SetName	(Inherited from SoBase.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoBase.)

Top

Properties

	Name	Description
	disable	If true, the timer is disabled.
	duration	Duration of the active cycle.
	flags	Control flags.
	isActive	( OIV.Inventor.Fields.SoSFBool ) Is true during the active cycle.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	ramp	( OIV.Inventor.Fields.SoSFFloat ) Ramps linearly from 0.0 to 1.0.
	timeIn	Running time.
	timeOut	( OIV.Inventor.Fields.SoSFTime ) Elapsed time from the start.
	trigger	Start the cycle.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)

Top

Remarks

This engine is a timer that runs for a pre-set amount of time and then stops. By default, the OIV.Inventor.Engines.SoOneShot.timeIn input is connected to the realTime global field. It can, however, by connected to any other time source.

The timer is started when the OIV.Inventor.Engines.SoOneShot.trigger input is touched. It then runs for the specified OIV.Inventor.Engines.SoOneShot.duration, and updates the OIV.Inventor.Engines.SoOneShot.timeOut output with the time that has elapsed. During that time, the OIV.Inventor.Engines.SoOneShot.ramp output is also updated. The OIV.Inventor.Engines.SoOneShot.ramp output starts at 0.0 at the beginning of the cycle, and linearly increases until it reaches 1.0 at the end of the cycle.

You can disable the timer by setting the OIV.Inventor.Engines.SoOneShot.disable input to true. The output value remains 0.0 while the timer is disabled. If the timer is disabled in the middle of a cycle the output values will be set to 0.0.

The OIV.Inventor.Engines.SoOneShot.flags input contains control flags. Using the flags you can set the timer to be retriggerable in the middle of a cycle, and set the output values to stay high after the cycle has been completed. By default, these flags are not set.

FILE FORMAT/DEFAULT

OneShot {
duration 1
trigger
flags ()
disable false
timeIn <current time>
}

Reference

OIV.Inventor.Engines Namespace

OIV.Inventor.Engines.SoElapsedTime

OIV.Inventor.Engines.SoEngineOutput