SoCounter Class

SoCounter Class

Triggered integer counter.

Inheritance Hierarchy

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

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 SoCounter : SoEngine

Public Class SoCounter
	Inherits SoEngine

public ref class SoCounter : public SoEngine

type SoCounter =  
    class
        inherit SoEngine
    end

The SoCounter type exposes the following members.

Constructors

	Name	Description
	SoCounter	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
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	max	Maximum value for the counter.
	min	Minimum value for the counter.
	output	( OIV.Inventor.Fields.SoSFShort ) Counts min-to-max in step increments.
	reset	At the next trigger, reset the counter to the specified value.
	step	Counter step value.
	syncOut	( OIV.Inventor.Fields.SoSFTrigger ) Triggers at cycle start.
	trigger	Go to the next step.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)

Top

Remarks

This engine is a counter that outputs numbers, starting at a minimum value, increasing by a step value, and ending with a number that does not exceed the maximum value. It outputs the next number whenever the OIV.Inventor.Engines.SoCounter.trigger input is touched. When the maximum number is reached, it starts counting from the beginning again.

At any time the counter can be reset to a specific value by setting the OIV.Inventor.Engines.SoCounter.reset input field to that value. The next time the counter is triggered it will start counting from there. Note that the counter will always output numbers based on the min, max and step values, and setting the reset value does not affect those input fields. If the reset value is not a legal counter value, the counter will still behave as though it is.

If OIV.Inventor.Engines.SoCounter.reset is greater than OIV.Inventor.Engines.SoCounter.max, the counter is set to OIV.Inventor.Engines.SoCounter.max.
If OIV.Inventor.Engines.SoCounter.reset is less than OIV.Inventor.Engines.SoCounter.min, the counter is set to OIV.Inventor.Engines.SoCounter.min.
If OIV.Inventor.Engines.SoCounter.reset is between steps, the counter is set to the lower step value.

Each time a counting cycle is started, the OIV.Inventor.Engines.SoCounter.syncOut output is triggered. This output can be used to synchronize some other event with the counting cycle.

FILE FORMAT/DEFAULT

Counter {
min 0
max 1
step 1
trigger
reset 0
}

Reference

OIV.Inventor.Engines Namespace

OIV.Inventor.Engines.SoTimeCounter

OIV.Inventor.Engines.SoEngineOutput