#include <opennurbs_3dm_settings.h>

Inheritance diagram for ON_3dmRenderSettings:
ON_Object

Public Types

enum  RenderingSources : unsigned int { RenderingSources::ActiveViewport, RenderingSources::SpecificViewport, RenderingSources::NamedView, RenderingSources::SnapShot }
 
- Public Types inherited from ON_Object
enum  UserDataConflictResolution : unsigned char {
  UserDataConflictResolution::destination_object = 0, UserDataConflictResolution::source_object = 1, UserDataConflictResolution::source_copycount_gt = 2, UserDataConflictResolution::source_copycount_ge = 3,
  UserDataConflictResolution::destination_copycount_gt = 4, UserDataConflictResolution::destination_copycount_ge = 5, UserDataConflictResolution::delete_item = 6
}
 When a userdata item is copied or moved from a source object to a destination object, the ON_Object::UserDataConflictResolution enum values specify how conficts are resolved. Remark: A userdata item "conflict" occurs when both the destination and source object have a user data item with the same value of ON_UserData::m_userdata_uuid. More...
 

Public Member Functions

 ON_3dmRenderSettings ()=default
 
 ON_3dmRenderSettings (const ON_3dmRenderSettings &)=default
 
 ~ON_3dmRenderSettings ()=default
 
void Dump (ON_TextLog &text_log) const override
 Creates a text dump of the object. More...
 
ON_wString NamedView (void) const
 
ON_3dmRenderSettingsoperator= (const ON_3dmRenderSettings &)=default
 
bool Read (ON_BinaryArchive &) override
 Low level archive writing tool used by ON_BinaryArchive::ReadObject(). More...
 
RenderingSources RenderingSource (void) const
 
bool ScaleBackgroundToFit () const
 
void SetNamedView (const ON_wString &)
 
void SetRenderingSource (RenderingSources)
 
void SetScaleBackgroundToFit (bool bScaleBackgroundToFit)
 
void SetSnapshot (const ON_wString &)
 
void SetSpecificViewport (const ON_wString &)
 
ON_wString Snapshot (void) const
 
ON_wString SpecificViewport (void) const
 
bool Write (ON_BinaryArchive &) const override
 Low level archive writing tool used by ON_BinaryArchive::WriteObject(). More...
 
- Public Member Functions inherited from ON_Object
 ON_Object () ON_NOEXCEPT
 
 ON_Object (const ON_Object &)
 
virtual ~ON_Object ()
 
virtual ON_AggregateComponentStatus AggregateComponentStatus () const
 Call whenever a component status setting is modifed by directly changing it on a component in a way that will result in any saved information about the parent object's aggretate component status becoming invalid. More...
 
bool AttachUserData (class ON_UserData *pUserData)
 Attach user data to an object. More...
 
unsigned int ClearAllComponentStates () const
 Set all active level component states to ON_ComponentStatus::NoneSet. More...
 
virtual unsigned int ClearComponentStates (ON_ComponentStatus states_to_clear) const
 Clear the specified states on every component. More...
 
virtual unsigned int ClearComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_clear) const
 Clear states on an individual component. More...
 
unsigned int CopyUserData (const ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution)
 Expert user tool that copies user data items with positive values of ON_UserData.m_userdata_copycount from source_object to "this. More...
 
void CopyUserData (const ON_Object &source_object)
 Calls CopyUserData(source_object,ON_Object::UserDataConflictResolution::source_object). More...
 
virtual ON__UINT32 DataCRC (ON__UINT32 current_remainder) const
 Returns a CRC calculated from the information that defines the object. This CRC can be used as a quick way to see if two objects are not identical. More...
 
virtual bool DeleteComponents (const ON_COMPONENT_INDEX *ci_list, size_t ci_count)
 Delete the portions of the object identified in ci_list[]. More...
 
virtual void DestroyRuntimeCache (bool bDelete=true)
 Expert user function. If you are using openNURBS in its default configuration to read and write 3dm archives, you never need to call this function. Many objects employ lazy creation of (runtime) caches that save information to help speed geometric calculations. This function will destroy all runtime information. More...
 
bool DetachUserData (class ON_UserData *pUserData)
 Remove user data from an object. More...
 
void EmergencyDestroy ()
 Sets m_user_data_list = 0. More...
 
class ON_UserDataFirstUserData () const
 User data is stored as a linked list of ON_UserData classes. FirstUserData gets the first item in the linked list. This is the most recent item attached using AttachUserData(). Remark: To iterate through all the user data on an object, call FirstUserData() and then use ON_UserData::Next() to traverse the list. More...
 
virtual unsigned int GetComponentsWithSetStates (ON_ComponentStatus states_filter, bool bAllEqualStates, ON_SimpleArray< ON_COMPONENT_INDEX > &components) const
 
class ON_UserDataGetUserData (const ON_UUID &userdata_uuid) const
 Get a pointer to user data. More...
 
bool GetUserString (const wchar_t *key, ON_wString &string_value) const
 Get user string from the object. More...
 
int GetUserStringKeys (ON_ClassArray< ON_wString > &user_string_keys) const
 Get a list of all user string keys on the object. More...
 
int GetUserStrings (ON_ClassArray< ON_UserString > &user_strings) const
 Get a list of all user strings on the object. More...
 
bool IsKindOf (const ON_ClassId *pClassId) const
 Low level tool to test if an object is derived from a specified class. More...
 
virtual bool IsValid (class ON_TextLog *text_log=nullptr) const
 Tests an object to see if its data members are correctly initialized. More...
 
virtual void MarkAggregateComponentStatusAsNotCurrent () const
 Call whenever a component status setting is modifed by directly changing it on a component in a way that will result in any saved information about the parent object's aggretate component status becoming invalid. More...
 
virtual void MemoryRelocate ()
 The MemoryRelocate() function is called when an object's location in memory is changed. For example, if an object resides in a chunk of memory that is grown by calling a realloc that has to allocate a new chunk and copy the contents of the old chunk to the new chunk, then the location of the object's memory changes. In practice this happens when classes derived from ON_Object are stored in dynamic arrays, like the default implementation of ON_ObjectArray<>'s that use realloc to grow the dynamic array. More...
 
virtual ON_UUID ModelObjectId () const
 All objects in an opennurbs model have an id ( ON_Layer.m_layer_id, ON_Font.m_font_id, ON_Material.m_material_id, ON_3dmObjectAttributes.m_uuid ). More...
 
unsigned int MoveUserData (ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution, bool bDeleteAllSourceItems)
 Expert user tool that moves user data items from source_object to "this. More...
 
void MoveUserData (ON_Object &source_object)
 Calls MoveUserData(source_object,ON_Object::UserDataConflictResolution::source_object,true). More...
 
virtual ON::object_type ObjectType () const
 Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on. More...
 
ON_Objectoperator= (const ON_Object &)
 
void PurgeUserData ()
 PurgeUserData() removes all user data from object. More...
 
virtual unsigned int SetComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_set) const
 Set states on an individual component. More...
 
virtual unsigned int SetComponentStatus (ON_COMPONENT_INDEX component_index, ON_ComponentStatus status_to_copy) const
 Copy status settings to an individual component. More...
 
bool SetUserString (const wchar_t *key, const wchar_t *string_value)
 Attach a user string to the object. This information will perisist through copy construction, operator=, and file IO. More...
 
int SetUserStrings (int count, const ON_UserString *user_strings, bool bReplace)
 Append entries to the user string list More...
 
virtual unsigned int SizeOf () const
 
void TransformUserData (const class ON_Xform &xform)
 Objects derived from ON_Geometry must call TransformUserData() in their Transform() member function. More...
 
virtual bool UpdateReferencedComponents (const class ON_ComponentManifest &source_manifest, const class ON_ComponentManifest &destination_manifest, const class ON_ManifestMap &manifest_map)
 Uses the destination_manifest to update references to other components. This is typically done when a component's references came from a "source" context and are being updated to the "destination" context. For example, inserting one model into another when index, id, and name conflicts need to be resolved at the time of insertion. More...
 
int UserStringCount () const
 

Public Attributes

ON_Color m_ambient_light = ON_Color::Black
 
int m_antialias_style = 1
 
ON_wString m_background_bitmap_filename
 
ON_Color m_background_bottom_color = ON_Color::Gray160
 
ON_Color m_background_color = ON_Color::White
 
int m_background_style = 0
 
bool m_bCustomImageSize = false
 
bool m_bDepthCue = false
 
bool m_bFlatShade = false
 
bool m_bForceViewportAspectRatio = false
 
bool m_bRenderAnnotation = false
 
bool m_bRenderBackfaces = true
 
bool m_bRenderCurves = false
 
bool m_bRenderIsoparams = false
 
bool m_bRenderMeshEdges = false
 
bool m_bRenderPoints = false
 
bool m_bScaleBackgroundToFit = false
 
bool m_bTransparentBackground = false
 
bool m_bUseHiddenLights = false
 
bool m_bUsesAmbientAttr = true
 
bool m_bUsesAnnotationAttr = true
 
bool m_bUsesBackfaceAttr = false
 
bool m_bUsesBackgroundAttr = true
 
bool m_bUsesCurvesAttr = true
 
bool m_bUsesHiddenLightsAttr = true
 
bool m_bUsesIsoparmsAttr = true
 
bool m_bUsesMeshEdgesAttr = false
 
bool m_bUsesPointsAttr = false
 
ON_UUID m_embedded_image_file_id = ON_nil_uuid
 
double m_image_dpi = 72.0
 
int m_image_height = 600
 
ON::LengthUnitSystem m_image_us = ON::LengthUnitSystem::Inches
 
int m_image_width = 800
 
int m_shadowmap_height = 1000
 
double m_shadowmap_offset = 0.75
 
int m_shadowmap_style = 1
 
int m_shadowmap_width = 1000
 

Static Public Attributes

static const ON_3dmRenderSettings Default
 

Member Enumeration Documentation

◆ RenderingSources

enum ON_3dmRenderSettings::RenderingSources : unsigned int
strong
Enumerator
ActiveViewport 
SpecificViewport 
NamedView 
SnapShot 

Constructor & Destructor Documentation

◆ ON_3dmRenderSettings() [1/2]

ON_3dmRenderSettings::ON_3dmRenderSettings ( )
default

◆ ~ON_3dmRenderSettings()

ON_3dmRenderSettings::~ON_3dmRenderSettings ( )
default

◆ ON_3dmRenderSettings() [2/2]

ON_3dmRenderSettings::ON_3dmRenderSettings ( const ON_3dmRenderSettings )
default

Member Function Documentation

◆ Dump()

void ON_3dmRenderSettings::Dump ( ON_TextLog ) const
overridevirtual

Creates a text dump of the object.

Dump() is intended for debugging and is not suitable for creating high quality text descriptions of an object.

The default implementations of this virtual function prints the class's name.

Reimplemented from ON_Object.

◆ NamedView()

ON_wString ON_3dmRenderSettings::NamedView ( void  ) const

◆ operator=()

ON_3dmRenderSettings& ON_3dmRenderSettings::operator= ( const ON_3dmRenderSettings )
default

◆ Read()

bool ON_3dmRenderSettings::Read ( ON_BinaryArchive binary_archive)
overridevirtual

Low level archive writing tool used by ON_BinaryArchive::ReadObject().

Parameters
binary_archivearchive to read from
Returns
Returns true if the read is successful.

Use ON_BinaryArchive::ReadObject() to read objects. This Read() function should read the objects definition back into its data members.

The default implementation of this virtual function returns false and does nothing.

Reimplemented from ON_Object.

◆ RenderingSource()

RenderingSources ON_3dmRenderSettings::RenderingSource ( void  ) const

◆ ScaleBackgroundToFit()

bool ON_3dmRenderSettings::ScaleBackgroundToFit ( ) const

◆ SetNamedView()

void ON_3dmRenderSettings::SetNamedView ( const ON_wString )

◆ SetRenderingSource()

void ON_3dmRenderSettings::SetRenderingSource ( RenderingSources  )

◆ SetScaleBackgroundToFit()

void ON_3dmRenderSettings::SetScaleBackgroundToFit ( bool  bScaleBackgroundToFit)

◆ SetSnapshot()

void ON_3dmRenderSettings::SetSnapshot ( const ON_wString )

◆ SetSpecificViewport()

void ON_3dmRenderSettings::SetSpecificViewport ( const ON_wString )

◆ Snapshot()

ON_wString ON_3dmRenderSettings::Snapshot ( void  ) const

◆ SpecificViewport()

ON_wString ON_3dmRenderSettings::SpecificViewport ( void  ) const

◆ Write()

bool ON_3dmRenderSettings::Write ( ON_BinaryArchive binary_archive) const
overridevirtual

Low level archive writing tool used by ON_BinaryArchive::WriteObject().

Parameters
binary_archivearchive to write to
Returns
Returns true if the write is successful.

Use ON_BinaryArchive::WriteObject() to write objects. This Write() function should just write the specific definition of this object. It should not write and any chunk typecode or length information.

The default implementation of this virtual function returns false and does nothing.

Reimplemented from ON_Object.

Member Data Documentation

◆ Default

const ON_3dmRenderSettings ON_3dmRenderSettings::Default
static

◆ m_ambient_light

ON_Color ON_3dmRenderSettings::m_ambient_light = ON_Color::Black

◆ m_antialias_style

int ON_3dmRenderSettings::m_antialias_style = 1

◆ m_background_bitmap_filename

ON_wString ON_3dmRenderSettings::m_background_bitmap_filename

◆ m_background_bottom_color

ON_Color ON_3dmRenderSettings::m_background_bottom_color = ON_Color::Gray160

◆ m_background_color

ON_Color ON_3dmRenderSettings::m_background_color = ON_Color::White

◆ m_background_style

int ON_3dmRenderSettings::m_background_style = 0

◆ m_bCustomImageSize

bool ON_3dmRenderSettings::m_bCustomImageSize = false

◆ m_bDepthCue

bool ON_3dmRenderSettings::m_bDepthCue = false

◆ m_bFlatShade

bool ON_3dmRenderSettings::m_bFlatShade = false

◆ m_bForceViewportAspectRatio

bool ON_3dmRenderSettings::m_bForceViewportAspectRatio = false

◆ m_bRenderAnnotation

bool ON_3dmRenderSettings::m_bRenderAnnotation = false

◆ m_bRenderBackfaces

bool ON_3dmRenderSettings::m_bRenderBackfaces = true

◆ m_bRenderCurves

bool ON_3dmRenderSettings::m_bRenderCurves = false

◆ m_bRenderIsoparams

bool ON_3dmRenderSettings::m_bRenderIsoparams = false

◆ m_bRenderMeshEdges

bool ON_3dmRenderSettings::m_bRenderMeshEdges = false

◆ m_bRenderPoints

bool ON_3dmRenderSettings::m_bRenderPoints = false

◆ m_bScaleBackgroundToFit

bool ON_3dmRenderSettings::m_bScaleBackgroundToFit = false

◆ m_bTransparentBackground

bool ON_3dmRenderSettings::m_bTransparentBackground = false

◆ m_bUseHiddenLights

bool ON_3dmRenderSettings::m_bUseHiddenLights = false

◆ m_bUsesAmbientAttr

bool ON_3dmRenderSettings::m_bUsesAmbientAttr = true

◆ m_bUsesAnnotationAttr

bool ON_3dmRenderSettings::m_bUsesAnnotationAttr = true

◆ m_bUsesBackfaceAttr

bool ON_3dmRenderSettings::m_bUsesBackfaceAttr = false

◆ m_bUsesBackgroundAttr

bool ON_3dmRenderSettings::m_bUsesBackgroundAttr = true

◆ m_bUsesCurvesAttr

bool ON_3dmRenderSettings::m_bUsesCurvesAttr = true

◆ m_bUsesHiddenLightsAttr

bool ON_3dmRenderSettings::m_bUsesHiddenLightsAttr = true

◆ m_bUsesIsoparmsAttr

bool ON_3dmRenderSettings::m_bUsesIsoparmsAttr = true

◆ m_bUsesMeshEdgesAttr

bool ON_3dmRenderSettings::m_bUsesMeshEdgesAttr = false

◆ m_bUsesPointsAttr

bool ON_3dmRenderSettings::m_bUsesPointsAttr = false

◆ m_embedded_image_file_id

ON_UUID ON_3dmRenderSettings::m_embedded_image_file_id = ON_nil_uuid

◆ m_image_dpi

double ON_3dmRenderSettings::m_image_dpi = 72.0

◆ m_image_height

int ON_3dmRenderSettings::m_image_height = 600

◆ m_image_us

ON::LengthUnitSystem ON_3dmRenderSettings::m_image_us = ON::LengthUnitSystem::Inches

◆ m_image_width

int ON_3dmRenderSettings::m_image_width = 800

◆ m_shadowmap_height

int ON_3dmRenderSettings::m_shadowmap_height = 1000

◆ m_shadowmap_offset

double ON_3dmRenderSettings::m_shadowmap_offset = 0.75

◆ m_shadowmap_style

int ON_3dmRenderSettings::m_shadowmap_style = 1

◆ m_shadowmap_width

int ON_3dmRenderSettings::m_shadowmap_width = 1000