DzTimeRange Class Reference
[Basic Objects]

Represents an interval of time with a beginning and an end. More...

List of all members.

Properties

Number end
Number start

Methods

DzTimeRange add (Number time)
void extendEndsBy (Number time)
Number getDuration ()
void include (Number time)
void include (DzTimeRange range)
void intersect (DzTimeRange range)
Boolean isEmpty ()
Boolean isIncluded (Number time)
Boolean isIncluded (DzTimeRange range)
void makeEmpty ()
Boolean overlaps (DzTimeRange range)
DzTimeRange subtract (Number time)

Constructors

 DzTimeRange (DzTime start, DzTime end)
 DzTimeRange ()


Detailed Description

Represents an interval of time with a beginning and an end.

See DsTimeRange for DAZ Script implementation of this class.


Constructor & Destructor Documentation

DzTimeRange::DzTimeRange (  ) 

Default Constructor. Creates the timerange [DZ_MIN_TIME,DZ_MAX_TIME]

DzTimeRange::DzTimeRange ( DzTime  start,
DzTime  end 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.


Member Function Documentation

DzTimeRange DzTimeRange::add ( Number  time  ) 

Returns:
The result of adding the given amount of time to both ends of this range

void DzTimeRange::extendEndsBy ( Number  time  ) 

Extends the ends of this range by the given amount of time

Number DzTimeRange::getDuration (  ) 

Returns:
The length of the time range.

void DzTimeRange::include ( Number  time  ) 

Sets the time range to include the given time

void DzTimeRange::include ( DzTimeRange  range  ) 

Sets the time range to include the given time range

void DzTimeRange::intersect ( DzTimeRange  range  ) 

Sets this time range to the intersection with the given time range.

Boolean DzTimeRange::isEmpty (  ) 

Returns:
True if the range is length 0.

Boolean DzTimeRange::isIncluded ( Number  time  ) 

Returns:
True if the given time falls inside this range

Boolean DzTimeRange::isIncluded ( DzTimeRange  range  ) 

Returns:
True if the given range falls inside this range

void DzTimeRange::makeEmpty (  ) 

Sets the time range to be empty.

Boolean DzTimeRange::overlaps ( DzTimeRange  range  ) 

Returns:
True if the given range overlaps this range

DzTimeRange DzTimeRange::subtract ( Number  time  ) 

Returns:
The result of subtracting the given amount of time from both ends of the range


Member Data Documentation

Number DzTimeRange::end

The end of the time range.

Number DzTimeRange::start

The start of the time range.


Generated on Thu Sep 24 12:21:16 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.