Rhino C++ API  9.0
Public Member Functions | Friends | List of all members
ON_WorksessionModel Class Reference

#include <opennurbs_worksession.h>

Public Member Functions

 ON_WorksessionModel ()
 
 ON_WorksessionModel (const ON_WorksessionModel &src)
 
 ~ON_WorksessionModel ()
 
void AppendLayerOverride (const ON_WorksessionLayerOverride &layer_override)
 
const ON_wString FullPath () const
 Full path of the model file, as saved. Nothing checks that it exists. More...
 
bool IsActive () const
 
const ON_WorksessionLayerOverride * LayerOverride (int index) const
 
int LayerOverrideCount () const
 
ON_WorksessionModel & operator= (const ON_WorksessionModel &src)
 
const ON_WorksessionLayerValues & ParentLayerValues () const
 
const ON_wString RelativePath () const
 
void RemoveAllLayerOverrides ()
 
bool RemoveLayerOverride (int index)
 Returns false if index is out of range. More...
 
void SetActive (bool bActive)
 
void SetFullPath (const wchar_t *full_path)
 
bool SetLayerOverride (int index, const ON_WorksessionLayerOverride &layer_override)
 Returns false if index is out of range. More...
 
void SetParentLayerValues (const ON_WorksessionLayerValues &values)
 
void SetRelativePath (const wchar_t *relative_path)
 

Friends

class ON_WorksessionFile_Private
 

Detailed Description

Description: A model in a Rhino worksession (.rws) file.

Constructor & Destructor Documentation

◆ ON_WorksessionModel() [1/2]

ON_WorksessionModel::ON_WorksessionModel ( )

◆ ~ON_WorksessionModel()

ON_WorksessionModel::~ON_WorksessionModel ( )

◆ ON_WorksessionModel() [2/2]

ON_WorksessionModel::ON_WorksessionModel ( const ON_WorksessionModel &  src)

Member Function Documentation

◆ AppendLayerOverride()

void ON_WorksessionModel::AppendLayerOverride ( const ON_WorksessionLayerOverride &  layer_override)

◆ FullPath()

const ON_wString ON_WorksessionModel::FullPath ( ) const

Full path of the model file, as saved. Nothing checks that it exists.

◆ IsActive()

bool ON_WorksessionModel::IsActive ( ) const

True for the model that was active when the worksession was saved. Every other model is a reference model.

◆ LayerOverride()

const ON_WorksessionLayerOverride* ON_WorksessionModel::LayerOverride ( int  index) const

Returns nullptr if index is out of range. The pointer is valid only until the list of layer overrides next changes.

◆ LayerOverrideCount()

int ON_WorksessionModel::LayerOverrideCount ( ) const

Layer overrides for a reference model. Rhino does not save or use them for the active model. Version 4 files do not have them.

◆ operator=()

ON_WorksessionModel& ON_WorksessionModel::operator= ( const ON_WorksessionModel &  src)

◆ ParentLayerValues()

const ON_WorksessionLayerValues& ON_WorksessionModel::ParentLayerValues ( ) const

Settings of the layer Rhino adds as the parent of all of a reference model's layers. Version 4 files do not have them.

◆ RelativePath()

const ON_wString ON_WorksessionModel::RelativePath ( ) const

Path of the model file relative to the .rws file, as saved. Rhino uses it when the file is no longer at FullPath(). It can be empty. Version 4 files do not have it.

◆ RemoveAllLayerOverrides()

void ON_WorksessionModel::RemoveAllLayerOverrides ( )

◆ RemoveLayerOverride()

bool ON_WorksessionModel::RemoveLayerOverride ( int  index)

Returns false if index is out of range.

◆ SetActive()

void ON_WorksessionModel::SetActive ( bool  bActive)

◆ SetFullPath()

void ON_WorksessionModel::SetFullPath ( const wchar_t *  full_path)

◆ SetLayerOverride()

bool ON_WorksessionModel::SetLayerOverride ( int  index,
const ON_WorksessionLayerOverride &  layer_override 
)

Returns false if index is out of range.

◆ SetParentLayerValues()

void ON_WorksessionModel::SetParentLayerValues ( const ON_WorksessionLayerValues &  values)

◆ SetRelativePath()

void ON_WorksessionModel::SetRelativePath ( const wchar_t *  relative_path)

Friends And Related Function Documentation

◆ ON_WorksessionFile_Private

friend class ON_WorksessionFile_Private
friend