Public Member Functions | Public Attributes | Friends

FBOpticalSegment Class Reference

Search for all occurrences

Detailed Description

Optical segment class.

Definition at line 72 of file fboptical.h.

#include <fboptical.h>

Inheritance diagram for FBOpticalSegment:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  FBOpticalSegment (HFBModelOptical pOptical=NULL)
  Constructor.
  FBOpticalSegment (const FBOpticalSegment &pSegment)
  Constructor.
bool  operator== (const FBOpticalSegment &pValue) const
  Overloaded == operator.
FBOpticalSegment operator= (const FBOpticalSegment &pValue)
  Overloaded = operator.
virtual void  Reset ()
  Reset the marker segment.
virtual void  Cut (FBTime &pTime)
  Cut the segment for the marker at a given time.
virtual bool  IsValid ()
  Check if valid (if item exists).

Public Attributes

FBPropertyTimeSpan  OriginalTimeSpan
  Property: Original timespan for segment.
FBPropertyTimeSpan  TimeSpan
  Property: Current segment timespan.
FBPropertyAnimationNode  Data
  Property: Segment curve data.
FBPropertyBool  Used
  Property: Is segment used?
FBPropertyModelMarkerOptical  Marker
  Property: Optical marker.
FBPropertyTimeSpan  MarkerTimeSpan
  Property: Marker/Segment timespan.

Friends

class  FBPropertyListOpticalSegment
class  FBPropertyListMarkerSegment

Constructor & Destructor Documentation

FBOpticalSegment ( HFBModelOptical  pOptical = NULL )

Constructor.

Parameters:
pOptical Optical model(default=NULL).
FBOpticalSegment ( const FBOpticalSegment pSegment )

Constructor.

Parameters:
pSegment Optical segment to copy information from.

Member Function Documentation

bool operator== ( const FBOpticalSegment pValue ) const

Overloaded == operator.

Parameters:
pValue Segment to compare with.
Returns:
true if equal.
FBOpticalSegment& operator= ( const FBOpticalSegment pValue )

Overloaded = operator.

Parameters:
pValue Segment to copy.
Returns:
Copied segment.
virtual void Reset ( ) [virtual]

Reset the marker segment.

virtual void Cut ( FBTime pTime ) [virtual]

Cut the segment for the marker at a given time.

Parameters:
pTime Time to cut segment at.
virtual bool IsValid ( ) [virtual]

Check if valid (if item exists).

Returns:
true if segment is valid.

Friends And Related Function Documentation

friend class FBPropertyListOpticalSegment [friend]

Definition at line 122 of file fboptical.h.

friend class FBPropertyListMarkerSegment [friend]

Definition at line 123 of file fboptical.h.


Member Data Documentation

Property: Original timespan for segment.

Definition at line 113 of file fboptical.h.

Property: Current segment timespan.

Definition at line 114 of file fboptical.h.

FBPropertyAnimationNode Data

Property: Segment curve data.

Definition at line 115 of file fboptical.h.

Property: Is segment used?

Definition at line 116 of file fboptical.h.

FBPropertyModelMarkerOptical Marker

Property: Optical marker.

Definition at line 119 of file fboptical.h.

Property: Marker/Segment timespan.

Definition at line 120 of file fboptical.h.


The documentation for this class was generated from the following file:

FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment
FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment FBOpticalSegment