/////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). // All rights reserved. // // This software and its documentation and related materials are owned by // the Alliance. The software may only be incorporated into application // programs owned by members of the Alliance, subject to a signed // Membership Agreement and Supplemental Software License Agreement with the // Alliance. The structure and organization of this software are the valuable // trade secrets of the Alliance and its suppliers. The software is also // protected by copyright law and international treaty provisions. Application // programs incorporating this software must include the following statement // with their copyright notices: // // This application incorporates Open Design Alliance software pursuant to a license // agreement with Open Design Alliance. // Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. // All rights reserved. // // By use of this software, its documentation or related materials, you // acknowledge and accept the above terms. /////////////////////////////////////////////////////////////////////////////// #ifndef __NW_TIME_LINER_SIMULATE_DURATION_ELEMENT_H__ #define __NW_TIME_LINER_SIMULATE_DURATION_ELEMENT_H__ #include "NwObject.h" #include "NwTimeLinerTypes.h" class OdNwElementItemPath; /** \details This template class is a specialization of the OdSmartPtr class for OdNwElementItemPath object pointers. */ typedef OdSmartPtr OdNwElementItemPathPtr; /** This class represents a timeliner simulation duration element. */ class NWDBEXPORT OdNwTimeLinerSimulateDurationElement : public OdNwObject { //DOM-IGNORE-BEGIN ODRX_DECLARE_MEMBERS(OdNwTimeLinerSimulateDurationElement); //DOM-IGNORE-END public: /** \details Default constructor. */ OdNwTimeLinerSimulateDurationElement(); /** \details Virtual destructor. Frees allocated resources. */ virtual ~OdNwTimeLinerSimulateDurationElement(); /** \details Gets the playback duration in seconds. \returns The playback duration in seconds as an OdUInt64 value. */ OdUInt64 getPlaybackDuration() const; /** \details Returns the interval unit. \returns One of the enumerated items from the NwTimeLinerSimulateDurationIntervalUnit::Enum enumerated type. \remarks The returned type can be one of the following: Name Value Description NwTimeLinerSimulateDurationIntervalUnit::PERCENT 0 Percent NwTimeLinerSimulateDurationIntervalUnit::WEEKS 1 Weeks NwTimeLinerSimulateDurationIntervalUnit::DAYS 2 Days NwTimeLinerSimulateDurationIntervalUnit::HOURS 3 Hours NwTimeLinerSimulateDurationIntervalUnit::MINUTES 4 Minutes NwTimeLinerSimulateDurationIntervalUnit::SECONDS 5 Seconds */ NwTimeLinerSimulateDurationIntervalUnit::Enum getIntervalSizeUnits() const; /** \details Returns the interval size. \returns The interval size as an OdUInt64 value. */ OdUInt64 getIntervalSize() const; /** \details Returns the format string of the overlay text. \returns The format string of the overlay text. */ OdString getFormatStr() const; /** \details Returns the overlay text option. \returns The overlay text option. \remarks The returned type can be one of the following:
Name Value Description NwTimeLinerSimulateDurationOverlayText::NONE 0 None NwTimeLinerSimulateDurationOverlayText::TOP 1 Top NwTimeLinerSimulateDurationOverlayText::BOTTOM 2 Bottom */ NwTimeLinerSimulateDurationOverlayText::Enum getOverlayTextOption() const; /** \details Returns the view playback option. \returns One of the enumerated items from the NwTimeLinerSimulateDurationView::Enum enumerated type. \remarks The returned type can be one of the following:
Name Value Description NwTimeLinerSimulateDurationView::ACTUAL 0 Simulate the Actual schedule only NwTimeLinerSimulateDurationView::ACTUAL_PLANNED_DIFFERENCES 1 Simulate the Actual schedule against the Planned schedule. NwTimeLinerSimulateDurationView::PLANED 2 Simulate the Planned schedule only. NwTimeLinerSimulateDurationView::PLANED_ACTUAL_DIFFERENCES 3 Simulate the Actual schedule against the Planned schedule. NwTimeLinerSimulateDurationView::PLANNED_AGAINST_ACTUAL 4 Simulate the Actual schedule against the Planned schedule. */ NwTimeLinerSimulateDurationView::Enum getViewEnum() const; /** \details Returns the font name of the overlay text. \returns The font name of the overlay text as a string. */ OdString getFontName() const; /** \details Returns the italic font sign. \returns The italic font sign as an OdUInt32 value. */ OdUInt32 getFontSize() const; /** \details Returns the font weight of the overlay text. \returns The font weight of the overlay text as an OdUInt32 value. \remarks For details about the returned value you can get from the LOGFONTA structure, see the field lfWeight in LOGFONTA structure. */ OdUInt32 getFontWeight() const; /** \details Returns the font size of the overlay text. \returns The font size of the overlay text. */ bool getFontItalicStyle() const; /** \details Returns the overidden start date that the simulation runs between. \returns The overidden start date. */ time_t getStartDate() const; /** \details Returns the overridden end date that the simulation runs between. \returns The overidden end date. */ time_t getEndDate() const; /** \details Returns whether there are override dates. \returns The true value if override dates are provided, or false otherwise. */ bool getOverrideDates() const; /** \details Indicates whether the show all tasks option is present. \returns The true value if the show all tasks option is present, or false otherwise. */ bool getShowAllTask() const; /** \details Returns the animation option. \returns One of the enumerated items from the NwTimeLinerSimulateDurationAnimation::Enum enumerated type. \remarks The returned type can be one of the following:
Name Value Description NwTimeLinerSimulateDurationAnimation::NOLINK 0 No viewpoint or camera animation will be played. NwTimeLinerSimulateDurationAnimation::SAVEDVIEWPOINTS 1 Links to the selected viewpoint or viewpoint animation. NwTimeLinerSimulateDurationAnimation::CAMERA_ANIMATION 2 Links to the selected camera animation. */ NwTimeLinerSimulateDurationAnimation::Enum getAnimation() const; /** \details Returns the smart pointer to OdNwElementItemPath object. \returns The path to saved animation element. */ OdNwElementItemPathPtr getSavedViewPointAnimationPath() const; /** \details Indicates whether the animation uses a saved viewpoint animation. \returns The true value if the animation uses a saved viewpoint animation, or false otherwise. */ bool getSavedViewPointAnimationFlag() const; }; /** \details This template class is a specialization of the OdSmartPtr class for OdNwTimeLinerSimulateDurationElement object pointers. */ typedef OdSmartPtr OdNwTimeLinerSimulateDurationElementPtr; #endif /* __NW_TIME_LINER_SIMULATE_DURATION_ELEMENT_H__ */