Rhino C++ API  7.24
Public Member Functions | List of all members
CRhinoSurfaceObject Class Reference

#include <rhinoSdkBrepObject.h>

Inheritance diagram for CRhinoSurfaceObject:
CRhinoBrepObject CRhinoObject ON_Object

Public Member Functions

 CRhinoSurfaceObject ()
 assigns a new object UUID More...
 CRhinoSurfaceObject (const CRhinoSurfaceObject &)
 copies source object UUID More...
 CRhinoSurfaceObject (const ON_3dmObjectAttributes &)
 assigns a new object UUID More...
 ~CRhinoSurfaceObject ()
CRhinoSurfaceObjectoperator= (const CRhinoSurfaceObject &)
 copies source object UUID More...
void SetSurface (ON_Surface *)
 ~CRhinoBrepObject() will delete the surface More...
const ON_SurfaceSurface () const
- Public Member Functions inherited from CRhinoBrepObject
 CRhinoBrepObject ()
 assigns a new object UUID More...
 CRhinoBrepObject (const CRhinoBrepObject &)
 copies source object UUID More...
 CRhinoBrepObject (const ON_3dmObjectAttributes &)
 assigns a new object UUID More...
 ~CRhinoBrepObject ()
ON_BoundingBox BoundingBox () const override
 virtual CRhinoObject::BoundingBox override More...
ON_BoundingBox BoundingBox (const class CRhinoViewport *pViewport) const override
 virtual CRhinoObject::BoundingBox override More...
const ON_BrepBrep () const
class CRhBrepDisplay * BrepDisplay () const
bool BrepDisplayExists () const
int CreateMeshes (ON::mesh_type, const ON_MeshParameters &, bool bIgnoreCustom=false) override
 virtual CRhinoObject::CreateMeshes override More...
void DeleteFromDocNotification () override
void DestroyMeshes (ON::mesh_type meshType, bool deleteMeshes=true) override
 virtual CRhinoObject::DestroyMeshes override More...
void DestroyRuntimeCache (bool bDelete=true) override
void Draw (CRhinoDisplayPipeline &dp) const override
 virtual CRhinoObject::Draw override More...
void DrawHighlightedSubObjects (CRhinoDisplayPipeline &dp) const override
 virtual CRhinoObject::DrawHighlightedSubObjects override More...
void DrawSubObject (CRhinoDisplayPipeline &dp, ON_COMPONENT_INDEX componentIndex) const override
 virtual CRhinoObject::DrawSubObject override More...
virtual void DrawV6 (class CRhinoObjectDrawContext *drawContext) const RHINO_NOEXCEPT override
 virtual CRhinoObject::DrawV6 override More...
void EnableGrips (bool gripsOn) override
 virtual CRhinoObject::EnableGrips override More...
bool GetFrame (ON_Plane &plane) const override
int GetHighlightedSubObjects (ON_SimpleArray< ON_COMPONENT_INDEX > &componentIndices) const override
int GetMeshes (ON::mesh_type, ON_SimpleArray< const ON_Mesh * > &) const override
 virtual CRhinoObject::GetMeshes override More...
int GetSelectedSubObjects (ON_SimpleArray< ON_COMPONENT_INDEX > &componentIndices) const override
int GetSubObjects (ON_SimpleArray< CRhinoObject * > &subObjects, const class CRhinoViewport *pViewport=nullptr) const override
 virtual CRhinoObject::GetSubObjects override More...
bool GetTightBoundingBox (ON_BoundingBox &tightBbox, bool growBox=false, const ON_Xform *xform=nullptr) const override
 virtual CRhinoObject::GetTightBoundingBox override More...
int GetWireframeCurves (ON_SimpleArray< ON_Curve * > &curveList) const override
 virtual CRhinoObject::GetWireframeCurves override More...
bool HighlightRequiresRedraw () const override
bool HighlightSubObject (ON_COMPONENT_INDEX componentIndex, bool highlight=true) const override
bool IsMeshable (ON::mesh_type) const override
 virtual CRhinoObject::IsMeshable override More...
bool IsSolid () const override
 virtual CRhinoObject::IsSolid override More...
bool IsSubObjectHighlighted (ON_COMPONENT_INDEX componentIndex) const override
 true if specified component is highlighted More...
bool IsSubObjectSelected (ON_COMPONENT_INDEX componentIndex) const override
int MeshCount (ON::mesh_type meshType, const ON_MeshParameters *mp=nullptr) const override
 virtual CRhinoObject::MeshCount override More...
const class CDisplayPipelineAttributesMeshDisplayAttributes (int meshIndex, const ON_Mesh &mesh, const class CDisplayPipelineAttributes &displayAttrs) const override
 virtual CRhinoObject::MeshDisplayAttributes override More...
ON::object_type ObjectType () const override
CRhinoBrepObjectoperator= (const CRhinoBrepObject &)
 copies source object UUID More...
int Pick (const CRhinoPickContext &pickContext, CRhinoObjRefArray &objRefs) const override
 virtual CRhinoObject::Pick override More...
bool PickFilter (const CRhinoGetObject &go, bool) const override
 virtual CRhinoObject::PickFilter override More...
bool PromotePreviewMeshes (ON::mesh_type) override
int SelectSubObject (ON_COMPONENT_INDEX componentIndex, bool select=true, bool synchHighlight=true, bool persistentSelect=false) const override
void SetBrep (ON_Brep *brep)
 ~CRhinoBrepObject() will delete the brep More...
bool SetRenderMeshParameters (const ON_MeshParameters &mp) override
 virtual CRhinoObject::SetRenderMeshParameters override More...
bool SetTextureCoordinates (const ON_TextureMapping &mapping, const ON_Xform *objectXform, bool lazy=true) const override
 virtual CRhinoObject::SetTextureCoordinates override More...
const wchar_t * ShortDescription (bool plural) const override
bool SnapTo (const CRhinoSnapContext &snapContext, CRhinoSnapEvent &snapEvent) const override
 virtual CRhinoObject::SnapTo override More...
int UnhighlightAllSubObjects () override
 returns number of changed subobjects More...
int UnselectAllSubObjects () override
 returns number of unselected subobjects More...
- Public Member Functions inherited from CRhinoObject
 CRhinoObject ()
 assigns a new object UUID More...
 CRhinoObject (const CRhinoObject &)
 copies source object UUID More...
 CRhinoObject (const ON_3dmObjectAttributes &)
virtual ~CRhinoObject ()
virtual void AddToDocNotification ()
BOOL AttachAttributeUserData (ON_UserData *pUserData)
bool AttachGeometryUserData (ON_UserData *pUserData)
virtual const CRhinoObjectAttributesAttributes () const
virtual void BeginTransform (CRhinoDoc &doc, bool bDeleteOriginal, bool bAddNewObjectToDoc, bool bAddTransformHistory)
unsigned int BrepReferenceCount () const
class CRhObjectReferenceCounter * BrepReferenceCounter (void) const
void BrepReferenceCounter_DestroyRuntimeCache (bool bDelete) const
bool BrepReferenceCounterExists () const
bool CopyHistoryOnReplace () const
BOOL DeleteAttributeUserData (ON_UUID userdata_uuid)
void DeleteDynamicTransform ()
bool DeleteGeometryUserData (ON_UUID userdata_uuid)
void DestroyRuntimeCache (bool bDelete=true) override
 virtual ON_Object override More...
class CRhinoDocDocument () const
unsigned int DocumentRuntimeSerialNumber () const
void Draw (CRhinoViewport &) const
virtual void DrawGrips (class CRhinoDisplayPipeline &) const
virtual CRhinoObjectDuplicateRhinoObject () const
*enum ANALYSIS_MODE **bool EnableAnalysisMode (ON_UUID am_id, bool bEnable=true) const
 new way (not virtual) More...
virtual bool EnableCustomGrips (class CRhinoObjectGrips *custom_grips)
virtual void EndTransform (CRhinoDoc &doc, bool bDeleteOriginal, bool bAddNewObjectToDoc, bool bAddTransformHistory)
const ON_GeometryGeometry () const
 returns a pointer to the object's geometry More...
ON_UserDataGetAttributeUserData (ON_UUID userdata_uuid) const
bool GetDynamicTransform (ON_Xform &dynamic_xform) const
ON_UserDataGetGeometryUserData (ON_UUID userdata_uuid) const
virtual int GetGrips (ON_SimpleArray< class CRhinoGripObject * > &grip_list) const
void GetRenderMeshParameters (ON_MeshParameters &mp) const
const class CRhinoGripsEnablerGripsEnabler () const
int GripsOn () const
bool GripsSelected () const
bool HasDynamicTransform () const
bool Highlight (bool bHighlight=true) const
const CRhinoHistoryRecordHistoryRecord () const
const ON_UUID Id () const
bool InAnalysisMode () const
bool InAnalysisMode (const ON_UUID &am_id) const
 bool AnalysisMode( ANALYSIS_MODE am ) const; ///< old way More...
const class CRhinoVisualAnalysisModeInShadedAnalysisMode () const
unsigned int IsActiveInDocument () const
virtual bool IsActiveInViewport (const class CRhinoViewport &) const
virtual bool IsDeletable () const
bool IsDeleted () const
virtual bool IsGroupObject () const
bool IsHidden () const
int IsHighlighted (BOOL bCheckSubObjects=false) const
 highlighted state (almost always = IsSelected() except in one or two commands) More...
bool IsInstanceDefinitionGeometry () const
int IsInstanceDefinitionGeometryEx () const
bool IsLocked () const
int IsMarked () const
bool IsModelObject () const
bool IsNormal () const
bool IsPageObject () const
int IsProxy () const
bool IsReference () const
bool IsSelectable (bool bIgnoreSelectionState, bool bIgnoreGripsState, bool bIgnoreLocking, bool bIgnoreVisibility) const
bool IsSelectable (bool bIgnoreSelectionState=false, bool bIgnoreGripsState=false) const
int IsSelected (bool bCheckSubObjects=false) const
bool IsSubObjectSelectable (ON_COMPONENT_INDEX component_index, bool bIgnoreSelectionState=false) const
bool IsValid (ON_TextLog *text_log=nullptr) const override
bool IsVisible () const
unsigned int LinkedInstanceDefinitionSerialNumber () const
void Mark (int)
void MemoryRelocate () override
 virtual ON_Object override More...
const ON_ModelComponentModelComponent () const
ON_UUID ModelObjectId () const override
virtual bool ModifyAttributes (const ON_3dmObjectAttributes &new_attributes, bool bEnableUndo=true, bool bQuiet=false)
const ON_wString Name () const
ON_Color ObjectDrawColor (bool bIgnoreObjectState=false) const
ON_Color ObjectDrawColor (const CRhinoObjectAttributes &attributes, bool bIgnoreObjectState=false) const
ON_Color ObjectDrawColor (const CRhinoObjectAttributes &attributes, const ON_UUID &viewport_id, bool bIgnoreObjectState) const
const class CRhinoLayerObjectLayer () const
const class CRhinoLayerObjectLayerPtr () const
const CRhinoLinetypeObjectLinetype () const
const CRhinoLinetypeObjectLinetypePtr () const
virtual const CRhinoMaterialObjectMaterial () const
virtual const CRhinoMaterialObjectMaterial (const ON_3dmObjectAttributes &attrs) const
virtual const CRhinoMaterialObjectMaterial (const ON_UUID &plugin_id) const
virtual ON_wString OnDoubleClick (const CRhinoDoubleClickContext &double_click_context) const
CRhinoObjectoperator= (const CRhinoObject &)
 copies source object UUID More...
bool PerViewportIsVisible (ON_UUID viewport_id) const
virtual bool PickFilter (const class CRhinoGetObject &, bool) const
virtual void PreDrawUpdate (CRhinoDisplayPipeline &dp) const
virtual bool PrepareToWrite (int archive_3dm_version)
unsigned int RuntimeSerialNumber () const
int Select (bool bSelect, bool bSynchHighlight, bool bPersistentSelect, bool bIgnoreGripsState, bool bIgnoreLayerLocking, bool bIgnoreLayerVisibility) const
int Select (bool bSelect=true, bool bSynchHighlight=true, bool bPersistentSelect=true, bool bIgnoreGripsState=false) const
void SetCopyHistoryOnReplace (bool bCopy) const
bool SetDynamicTransform (const ON_Xform &dynamic_xform)
bool SetHistory (class CRhinoHistory &history)
virtual bool SetTextureCoordinatesFromPlugIn (const ON_UUID &plugin_id, int mapping_channel_id) const
virtual unsigned int SizeOf () const
 returns number of bytes used by this particular instance More...
virtual ON_ComponentStatus SubObjectStatus () const
virtual bool SupportsBrepProxyReferenceCounting () const
bool UndoModifyAttributes (unsigned int ur_sn=0)
void UpdateBoundingBox ()
virtual bool VetoTransformObject (CRhinoDoc &doc, bool bDeleteOriginal, bool bAddNewObjectToDoc, bool bAddTransformHistory) const
unsigned int WorksessionReferenceModelSerialNumber () const
- Public Member Functions inherited from ON_Object
 ON_Object (const ON_Object &)
virtual ~ON_Object ()
virtual ON_AggregateComponentStatus AggregateComponentStatus () const
bool AttachUserData (class ON_UserData *pUserData)
unsigned int ClearAllComponentStates () const
virtual unsigned int ClearComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_clear) const
virtual unsigned int ClearComponentStates (ON_ComponentStatus states_to_clear) const
void CopyUserData (const ON_Object &source_object)
unsigned int CopyUserData (const ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution)
virtual ON__UINT32 DataCRC (ON__UINT32 current_remainder) const
virtual bool DeleteComponents (const ON_COMPONENT_INDEX *ci_list, size_t ci_count)
bool DetachUserData (class ON_UserData *pUserData)
virtual void Dump (ON_TextLog &) const
void EmergencyDestroy ()
class ON_UserDataFirstUserData () const
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
bool GetUserString (const wchar_t *key, ON_wString &string_value) const
int GetUserStringKeys (ON_ClassArray< ON_wString > &user_string_keys) const
int GetUserStrings (ON_ClassArray< ON_UserString > &user_strings) const
bool IsCorrupt (bool bRepair, bool bSilentError, class ON_TextLog *text_log) const
bool IsKindOf (const ON_ClassId *pClassId) const
virtual void MarkAggregateComponentStatusAsNotCurrent () const
void MoveUserData (ON_Object &source_object)
unsigned int MoveUserData (ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution, bool bDeleteAllSourceItems)
ON_Objectoperator= (const ON_Object &)
void PurgeUserData ()
virtual bool Read (ON_BinaryArchive &binary_archive)
virtual unsigned int SetComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_set) const
virtual unsigned int SetComponentStatus (ON_COMPONENT_INDEX component_index, ON_ComponentStatus status_to_copy) const
bool SetUserString (const wchar_t *key, const wchar_t *string_value)
int SetUserStrings (int count, const ON_UserString *user_strings, bool bReplace)
bool ThisIsNullptr (bool bSilentError) const
void TransformUserData (const class ON_Xform &xform)
virtual bool UpdateReferencedComponents (const class ON_ComponentManifest &source_manifest, const class ON_ComponentManifest &destination_manifest, const class ON_ManifestMap &manifest_map)
int UserStringCount () const
virtual bool Write (ON_BinaryArchive &binary_archive) const

Additional Inherited Members

- Public Types inherited from CRhinoObject
  unknown_object_type = ON::object_type::unknown_object_type, point_object = ON::object_type::point_object, pointset_object = ON::object_type::pointset_object, curve_object = ON::object_type::curve_object,
  surface_object = ON::object_type::surface_object, polysrf_object = ON::object_type::polysrf_filter, edge_object = ON::object_type::edge_filter, polyedge_object = ON::object_type::polyedge_filter,
  loop_object = ON::object_type::loop_object, brepvertex_filter = ON::object_type::brepvertex_filter, mesh_object = ON::object_type::mesh_object, annotation_object = ON::object_type::annotation_object,
  light_object = ON::object_type::light_object, instance_reference = ON::object_type::instance_reference, grip_object = ON::object_type::grip_object, morph_control_object = ON::object_type::morph_control_object,
  subd_object = ON::object_type::subd_object, meshvertex_filter = ON::object_type::meshvertex_filter, meshedge_filter = ON::object_type::meshedge_filter, meshface_filter = ON::object_type::meshface_filter,
  meshcomponent_reference = ON::object_type::meshcomponent_reference, cage_object = ON::object_type::cage_object, hatch_object = ON::object_type::hatch_object, phantom_object = ON::object_type::phantom_object,
  extrusion_object = ON::object_type::extrusion_object, any_object = ON::object_type::any_object
- 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
- Static Public Member Functions inherited from CRhinoObject
static const CRhinoObjectFromId (unsigned int rhino_doc_runtime_serial_number, ON_UUID rhino_object_id)
static const CRhinoObjectFromRuntimeSerialNumber (unsigned int rhino_doc_runtime_serial_number, unsigned int rhino_object_runtime_serial_number)
static unsigned int NextRuntimeObjectSerialNumber ()
- Public Attributes inherited from CRhinoObject
class CRhObjectSdkExtension * m__object_sdk_extension
const class CRhinoObjectVisualAnalysisModem_analysis_mode_list
 list of enabled analysis modes More...
CRhinoCacheHandle m_cache
class CRhinoObjectGripsm_grips
 managed by derived objects More...
unsigned char m_use_preview_mesh
- Static Public Attributes inherited from CRhinoObject
static int m_no_show_mark
- Protected Member Functions inherited from CRhinoBrepObject
int GetSubobjectMaterialComponents (ON_SimpleArray< ON_COMPONENT_INDEX > &componentsWithSubobjectMaterials) const override
bool HasSubobjectMaterials () const override
virtual const CRhinoMaterialObjectMaterial () const
virtual const CRhinoMaterialObjectMaterial (const ON_3dmObjectAttributes &attrs) const
virtual const CRhinoMaterialObjectMaterial (const ON_COMPONENT_INDEX &ci, const ON_UUID &plugin_id=RhinoDefaultRendererId(), const ON_3dmObjectAttributes *attrs=NULL) const
 This is now the preferred version of the function. This should be used to get materials component-wise in all cases. More...
const CRhinoMaterialObjectMaterial (const ON_COMPONENT_INDEX &ci, const ON_UUID &plugin_id=RhinoDefaultRendererId(), const ON_3dmObjectAttributes *attrs=nullptr) const override
 This is now the preferred version of the function. This should be used to get materials component-wise in all cases. More...
virtual const CRhinoMaterialObjectMaterial (const ON_UUID &plugin_id) const
const CRhRdkMaterialObjectRdkMaterial (const ON_COMPONENT_INDEX &ci, const ON_UUID &plugin_id=RhinoDefaultRendererId(), const ON_3dmObjectAttributes *attrs=nullptr) const override
int SubObjectsAreHighlighted () const override
 returns number of highlighted subobjects More...
int SubObjectsAreSelected () const override
 virtual overrides to support subobject selection More...
- Protected Member Functions inherited from CRhinoObject
void Destroy ()
virtual bool InternalVirtual_IsSelectable (bool bIgnoreSelectionState, bool bIgnoreGripsState, bool bIgnoreLocking, bool bIgnoreVisibility) const
virtual bool IsSelectableWithGripsOn () const
 true if can be selected while grips are on More...
virtual void SynchAttributes ()
 light objects are special because they are not in the geometry lists More...
- Protected Attributes inherited from CRhinoObject
ON_BoundingBox m_bbox
 world coordinate bounding box More...
unsigned char m_geomem_type
const CRhinoHistoryRecordm_history_record

Constructor & Destructor Documentation

◆ CRhinoSurfaceObject() [1/3]

CRhinoSurfaceObject::CRhinoSurfaceObject ( )

assigns a new object UUID

◆ CRhinoSurfaceObject() [2/3]

CRhinoSurfaceObject::CRhinoSurfaceObject ( const ON_3dmObjectAttributes )

assigns a new object UUID

◆ ~CRhinoSurfaceObject()

CRhinoSurfaceObject::~CRhinoSurfaceObject ( )

◆ CRhinoSurfaceObject() [3/3]

CRhinoSurfaceObject::CRhinoSurfaceObject ( const CRhinoSurfaceObject )

copies source object UUID

Member Function Documentation

◆ operator=()

CRhinoSurfaceObject& CRhinoSurfaceObject::operator= ( const CRhinoSurfaceObject )

copies source object UUID

◆ SetSurface()

void CRhinoSurfaceObject::SetSurface ( ON_Surface )

~CRhinoBrepObject() will delete the surface

◆ Surface()

const ON_Surface* CRhinoSurfaceObject::Surface ( ) const