FBOpticalSegment Class Reference

Search for all occurrences

---

Detailed Description

Optical segment class.

Inheritance diagram for FBOpticalSegment:

List of all members.

Public Member Functions
	__init__ (HFBModelOptical pOptical=None)
	Constructor.
	__init__ (FBOpticalSegment pSegment)
	Constructor.
bool	operator== (FBOpticalSegment pValue)
	Overloaded == operator.
FBOpticalSegment	operator= (FBOpticalSegment pValue)
	Overloaded = operator.
	Reset ()
	Reset the marker segment.
	Cut (FBTime pTime)
	Cut the segment for the marker at a given time.
bool	IsValid ()
	Check if valid (if item exists).
Public Attributes
FBPropertyBase	OriginalTimeSpan
	Property: Original timespan for segment.
FBPropertyBase	TimeSpan
	Property: Current segment timespan.
FBPropertyAnimationNode	Data
	Property: Segment curve data.
FBPropertyBase	Used
	Property: Is segment used?.
FBPropertyModelMarkerOptical	Marker
	Property: Optical marker.
FBPropertyBase	MarkerTimeSpan
	Property: Marker/Segment timespan.

---

Member Function Documentation

__init__

(

HFBModelOptical

pOptical = None

)

Search for all occurrences

Constructor.

Parameters:

pOptical

Optical model(default=NULL).

__init__

(

FBOpticalSegment

pSegment

)

Search for all occurrences

Constructor.

Parameters:

pSegment

Optical segment to copy information from.

bool operator==

(

FBOpticalSegment

pValue

)

Overloaded == operator.

Parameters:

pValue

Segment to compare with.

Returns:

true if equal.

FBOpticalSegment operator=

(

FBOpticalSegment

pValue

)

Overloaded = operator.

Parameters:

pValue

Segment to copy.

Returns:

Copied segment.

Reset

(

)

Search for all occurrences

Reset the marker segment.

Cut

(

FBTime

pTime

)

Search for all occurrences

Cut the segment for the marker at a given time.

Parameters:

pTime

Time to cut segment at.

bool IsValid

(

)

Search for all occurrences

Check if valid (if item exists).

Returns:

true if segment is valid.

---

Member Data Documentation

FBPropertyBase OriginalTimeSpan

Search for all occurrences

Property: Original timespan for segment.

FBPropertyBase TimeSpan

Search for all occurrences

Property: Current segment timespan.

FBPropertyAnimationNode Data

Search for all occurrences

Property: Segment curve data.

FBPropertyBase Used

Search for all occurrences

Property: Is segment used?.

FBPropertyModelMarkerOptical Marker

Search for all occurrences

Property: Optical marker.

FBPropertyBase MarkerTimeSpan

Search for all occurrences

Property: Marker/Segment timespan.