2003-04-18 00:22:51 +08:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
< HTML >
< HEAD >
< TITLE > class OSGSIM_EXPORT osgSim::BlinkSequence< / TITLE >
< META NAME = "GENERATOR" CONTENT = "DOC++ 3.4.10" >
< / HEAD >
< BODY BGCOLOR = "#ffffff" >
< H2 > class OSGSIM_EXPORT < A HREF = "#DOC.DOCU" > osgSim::BlinkSequence< / A > < / H2 > < / H2 > < HR >
< H2 > Inheritance:< / H2 >
< APPLET CODE = "ClassGraph.class" WIDTH = 600 HEIGHT = 65 >
2003-07-23 19:27:31 +08:00
< param name = classes value = "Mosg::Object,M,CBlinkSequence,MBlinkSequence.html" >
2003-04-18 00:22:51 +08:00
< param name = before value = "M,M" >
< param name = after value = "Md_,M" >
< param name = indent value = "0,1" >
< param name = arrowdir value = "down" >
< / APPLET >
< HR >
< DL >
< P > < DL >
< DT > < H3 > Public Methods< / H3 > < DD > < DT >
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.1.2" > BlinkSequence< / A > < / B > ()
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.1.3" > BlinkSequence< / A > < / B > (const <!1> < A HREF = "BlinkSequence.html#DOC.2.1.3" > BlinkSequence< / A > & bs, const osg::CopyOp& copyop = osg::CopyOp::SHALLOW_COPY)
2003-04-18 00:22:51 +08:00
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.1.4" > META_Object< / A > < / B > (<!1> < A HREF = "osgSim.html" > osgSim< / A > , <!1> < A HREF = "BlinkSequence.html" > BlinkSequence< / A > )
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline int < B > < A HREF = "#DOC.2.1.5" > getNumPulses< / A > < / B > () const
< DD > < I > return the number of pulses.< / I >
< DT >
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline double < B > < A HREF = "#DOC.2.1.6" > getPulsePeriod< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > get the total pulse period of the blink sequence, which is equal to the sum of all the pulse periods< / I >
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.1.7" > setSequenceGroup< / A > < / B > (<!1> < A HREF = "SequenceGroup.html" > SequenceGroup< / A > * sg)
2003-04-18 00:22:51 +08:00
< DD > < I > set the sequence group which can be used to synchronize related blink sequences< / I >
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline <!1> < A HREF = "SequenceGroup.html" > SequenceGroup< / A > * < B > < A HREF = "#DOC.2.1.8" > getSequenceGroup< / A > < / B > ()
2003-04-18 00:22:51 +08:00
< DD > < I > get the non const sequence group< / I >
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const <!1> < A HREF = "SequenceGroup.html" > SequenceGroup< / A > * < B > < A HREF = "#DOC.2.1.9" > getSequenceGroup< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > get the const sequence group< / I >
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.1.10" > setPhaseShift< / A > < / B > (double ps)
2003-04-18 00:22:51 +08:00
< DD > < I > set the phase shift of the blink sequence, this would be used to shift a sequence within a sequence group< / I >
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline double < B > < A HREF = "#DOC.2.1.11" > getPhaseShift< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > get the pahse shift< / I >
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline double < B > < A HREF = "#DOC.2.1.18" > localTime< / A > < / B > (double time) const
2003-04-18 00:22:51 +08:00
< DD > < I > compute the local time clamped to this BlinkSequences period, and accounting for the phase shift and sequence group< / I >
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.1.19" > addPulse< / A > < / B > (double length, const osg::Vec4& <!1> < A HREF = "BlinkSequence.html#DOC.2.1.21" > color< / A > )
2003-04-18 00:22:51 +08:00
< DD > < I > add a pulse of specified color and duration to the BlinkSequence< / I >
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.1.20" > getPulse< / A > < / B > (unsigned int i, double& length, osg::Vec4& <!1> < A HREF = "BlinkSequence.html#DOC.2.1.21" > color< / A > ) const
< DD > < I > return the pulse data at position i.< / I >
< DT >
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline osg::Vec4 < B > < A HREF = "#DOC.2.1.21" > color< / A > < / B > (double time, double length) const
2003-04-18 00:22:51 +08:00
< DD > < I > compute the color for the time interval sepecifed.< / I >
< / DL > < / P >
< P > < DL >
< DT > < H3 > Public Members< / H3 > < DD > < DT >
2003-09-08 18:51:14 +08:00
class OSGSIM_EXPORT < B > < A HREF = "SequenceGroup.html" > SequenceGroup< / A > < / B > : public osg::Object
2003-04-18 00:22:51 +08:00
< DD > < I > sequence group which can be used to synchronize related blink sequences< / I >
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Fields< / H3 > < DD > < DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > double < B > < A HREF = "#DOC.2.1.14" > _pulsePeriod< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > double < B > < A HREF = "#DOC.2.1.15" > _phaseShift< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > <!1> < A HREF = "BlinkSequence.html#DOC.2.1.13" > PulseData< / A > < B > < A HREF = "#DOC.2.1.16" > _pulseData< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > osg::ref_ptr< <!1> < A HREF = "SequenceGroup.html" > SequenceGroup< / A > > < B > < A HREF = "#DOC.2.1.17" > _sequenceGroup< / A > < / B >
2003-04-18 00:22:51 +08:00
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Members< / H3 > < DD > < DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > typedef std::pair< double,osg::Vec4> < B > < A HREF = "#DOC.2.1.12" > IntervalColor< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2003-09-08 18:51:14 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > typedef std::vector< <!1> < A HREF = "BlinkSequence.html#DOC.2.1.12" > IntervalColor< / A > > < B > < A HREF = "#DOC.2.1.13" > PulseData< / A > < / B >
2003-04-18 00:22:51 +08:00
< / DL > < / P >
< / DL >
< A NAME = "DOC.DOCU" > < / A >
< HR >
< H2 > Documentation< / H2 >
< DL >
< A NAME = "BlinkSequence" > < / A >
< A NAME = "DOC.2.1.2" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > BlinkSequence()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "BlinkSequence" > < / A >
< A NAME = "DOC.2.1.3" > < / A >
2003-07-23 19:27:31 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > BlinkSequence(const <!1> < A HREF = "BlinkSequence.html#DOC.2.1.3" > BlinkSequence< / A > & bs, const osg::CopyOp& copyop = osg::CopyOp::SHALLOW_COPY)< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DL > < DT > < DD > < / DL > < P >
2003-07-23 19:27:31 +08:00
< A NAME = "META_Object" > < / A >
2003-04-18 00:22:51 +08:00
< A NAME = "DOC.2.1.4" > < / A >
2003-07-23 19:27:31 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > META_Object(<!1> < A HREF = "osgSim.html" > osgSim< / A > , <!1> < A HREF = "BlinkSequence.html" > BlinkSequence< / A > )< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
2003-09-08 18:51:14 +08:00
< A NAME = "getNumPulses" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.1.5" > < / A >
2003-09-08 18:51:14 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline int getNumPulses() const < / B > < / TT >
< DD > return the number of pulses.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getPulsePeriod" > < / A >
< A NAME = "DOC.2.1.6" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline double getPulsePeriod() const < / B > < / TT >
< DD > get the total pulse period of the blink sequence, which is equal to the sum of all the pulse periods
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setSequenceGroup" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.7" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setSequenceGroup(<!1> < A HREF = "SequenceGroup.html" > SequenceGroup< / A > * sg)< / B > < / TT >
< DD > set the sequence group which can be used to synchronize related blink sequences
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getSequenceGroup" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.8" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline <!1> < A HREF = "SequenceGroup.html" > SequenceGroup< / A > * getSequenceGroup()< / B > < / TT >
< DD > get the non const sequence group
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getSequenceGroup" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.9" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline const <!1> < A HREF = "SequenceGroup.html" > SequenceGroup< / A > * getSequenceGroup() const < / B > < / TT >
< DD > get the const sequence group
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setPhaseShift" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.10" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setPhaseShift(double ps)< / B > < / TT >
< DD > set the phase shift of the blink sequence, this would be used to shift a sequence within a sequence group
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getPhaseShift" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.11" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline double getPhaseShift() const < / B > < / TT >
< DD > get the pahse shift
< DL > < DT > < DD > < / DL > < P >
< A NAME = "IntervalColor" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.12" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > typedef std::pair< double,osg::Vec4> IntervalColor< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "PulseData" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.13" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > typedef std::vector< <!1> < A HREF = "BlinkSequence.html#DOC.2.1.12" > IntervalColor< / A > > PulseData< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_pulsePeriod" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.14" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > double _pulsePeriod< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_phaseShift" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.15" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > double _phaseShift< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_pulseData" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.16" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > <!1> < A HREF = "BlinkSequence.html#DOC.2.1.13" > PulseData< / A > _pulseData< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_sequenceGroup" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.17" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > osg::ref_ptr< <!1> < A HREF = "SequenceGroup.html" > SequenceGroup< / A > > _sequenceGroup< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "localTime" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.18" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline double localTime(double time) const < / B > < / TT >
< DD > compute the local time clamped to this BlinkSequences period, and accounting for the phase shift and sequence group
< DL > < DT > < DD > < / DL > < P >
< A NAME = "addPulse" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.19" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void addPulse(double length, const osg::Vec4& <!1> < A HREF = "BlinkSequence.html#DOC.2.1.21" > color< / A > )< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > add a pulse of specified color and duration to the BlinkSequence
< DL > < DT > < DD > < / DL > < P >
2003-09-08 18:51:14 +08:00
< A NAME = "getPulse" > < / A >
< A NAME = "DOC.2.1.20" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void getPulse(unsigned int i, double& length, osg::Vec4& <!1> < A HREF = "BlinkSequence.html#DOC.2.1.21" > color< / A > ) const < / B > < / TT >
< DD > return the pulse data at position i.
< DL > < DT > < DD > < / DL > < P >
2003-04-18 00:22:51 +08:00
< A NAME = "color" > < / A >
2003-09-08 18:51:14 +08:00
< A NAME = "DOC.2.1.21" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline osg::Vec4 color(double time, double length) const < / B > < / TT >
< DD > compute the color for the time interval sepecifed. Averages the colors if the length is greater than the current pulse.
< DL > < DT > < DD > < / DL > < P > < / DL >
< HR > < DL > < DT > < B > This class has no child classes.< / B > < / DL >
< DL > < DT > < DD > < / DL > < P > < P > < I > < A HREF = "index.html" > Alphabetic index< / A > < / I > < I > < A HREF = "HIER.html" > HTML hierarchy of classes< / A > or < A HREF = "HIERjava.html" > Java< / A > < / I > < / P > < HR >
< BR >
This page was generated with the help of < A HREF = "http://docpp.sourceforge.net" > DOC++< / A > .
< / BODY >
< / HTML >
