ON_OffsetSurface Class Reference

#include <opennurbs_offsetsurface.h>

Inheritance diagram for ON_OffsetSurface:
ON_SurfaceProxy ON_Surface ON_Geometry ON_Object

Public Member Functions

 ON_OffsetSurface ()
 
 ON_OffsetSurface (const ON_OffsetSurface &src)
 
 ~ON_OffsetSurface ()
 
const ON_SurfaceBaseSurface () const
 
bool Evaluate (double, double, int, int, double *, int=0, int *=0) const override
 work horse evaluator More...
 
bool GetBBox (double *boxmin, double *boxmax, bool bGrowBox=false) const override
 virtual ON_Geometry GetBBox override More...
 
ON_OffsetSurfaceFunctionOffsetFunction ()
 
const ON_OffsetSurfaceFunctionOffsetFunction () const
 
ON_OffsetSurfaceoperator= (const ON_OffsetSurface &src)
 
bool SetBaseSurface (const ON_Surface *base_surface)
 Sets base surface to a surface that is not managed by the ON_OffsetSurface class. More...
 
bool SetBaseSurface (ON_Surface *base_surface, bool bManage)
 Sets base surface to a surface that is optionally managed by the ON_OffsetSurface class. More...
 
- Public Member Functions inherited from ON_SurfaceProxy
 ON_SurfaceProxy ()
 
 ON_SurfaceProxy (const ON_Surface *)
 
 ON_SurfaceProxy (const ON_SurfaceProxy &)
 
virtual ~ON_SurfaceProxy ()
 
ON__UINT32 DataCRC (ON__UINT32 current_remainder) const override
 virtual ON_Object::DataCRC override More...
 
int Degree (int) const override
 
void DestroyRuntimeCache (bool bDelete=true) override
 virtual ON_Object::DestroyRuntimeCache override More...
 
int Dimension () const override
 ON_Geometry overrides. More...
 
ON_Interval Domain (int) const override
 ON_Surface overrides. More...
 
void Dump (ON_TextLog &) const override
 Creates a text dump of the object. More...
 
ON_SurfaceDuplicateSurface () const override
 Get a duplicate of the surface. More...
 
bool Evaluate (double, double, int, int, double *, int=0, int *=0) const override
 work horse evaluator More...
 
bool GetBBox (double *boxmin, double *boxmax, bool bGrowBox=false) const override
 virtual ON_Geometry GetBBox override More...
 
bool GetNextDiscontinuity (int dir, ON::continuity c, double t0, double t1, double *t, int *hint=nullptr, int *dtype=nullptr, double cos_angle_tolerance=ON_DEFAULT_ANGLE_TOLERANCE_COSINE, double curvature_tolerance=ON_SQRT_EPSILON) const override
 Search for a derivatitive, tangent, or curvature discontinuity. More...
 
int GetNurbForm (ON_NurbsSurface &, double=0.0) const override
 Get a NURBS surface representation of this surface. More...
 
bool GetNurbFormParameterFromSurfaceParameter (double surface_s, double surface_t, double *nurbs_s, double *nurbs_t) const override
 
bool GetParameterTolerance (int, double, double *, double *) const override
 
bool GetSpanVector (int, double *) const override
 
bool GetSurfaceParameterFromNurbFormParameter (double nurbs_s, double nurbs_t, double *surface_s, double *surface_t) const override
 
bool GetSurfaceSize (double *width, double *height) const override
 Get an estimate of the size of the rectangle that would be created if the 3d surface where flattened into a rectangle. More...
 
int HasNurbForm () const override
 Is there a NURBS surface representation of this surface. More...
 
bool IsClosed (int) const override
 
bool IsContinuous (ON::continuity c, double s, double t, int *hint=nullptr, double point_tolerance=ON_ZERO_TOLERANCE, double d1_tolerance=ON_ZERO_TOLERANCE, double d2_tolerance=ON_ZERO_TOLERANCE, double cos_angle_tolerance=ON_DEFAULT_ANGLE_TOLERANCE_COSINE, double curvature_tolerance=ON_SQRT_EPSILON) const override
 Test continuity at a surface parameter value. More...
 
ON_Surface::ISO IsIsoparametric (const ON_Curve &curve, const ON_Interval *curve_domain=nullptr) const override
 override virtual ON_Surface::IsIsoparametric More...
 
ON_Surface::ISO IsIsoparametric (const ON_BoundingBox &bbox) const override
 override virtual ON_Surface::IsIsoparametric More...
 
ON_CurveIsoCurve (int dir, double c) const override
 Get isoparametric curve. More...
 
bool IsPeriodic (int) const override
 
bool IsPlanar (ON_Plane *plane=nullptr, double tolerance=ON_ZERO_TOLERANCE) const override
 Test a surface to see if it is planar. More...
 
bool IsSingular (int) const override
 
bool IsValid (class ON_TextLog *text_log=nullptr) const override
 Tests an object to see if its data members are correctly initialized. More...
 
ON_SurfaceProxyoperator= (const ON_SurfaceProxy &)
 
const ON_SurfaceProxySurface () const
 
bool ProxySurfaceIsTransposed () const
 
bool Read (ON_BinaryArchive &) override
 Low level archive writing tool used by ON_BinaryArchive::ReadObject(). More...
 
bool Reverse (int) override
 
void SetProxySurface (const ON_Surface *proxy_surface)
 
unsigned int SizeOf () const override
 ON_Object overrides. More...
 
int SpanCount (int) const override
 
bool Transform (const ON_Xform &) override
 Transforms the object. More...
 
bool Transpose () override
 
bool Write (ON_BinaryArchive &) const override
 Low level archive writing tool used by ON_BinaryArchive::WriteObject(). More...
 
- Public Member Functions inherited from ON_Surface
 ON_Surface ()
 
 ON_Surface (const ON_Surface &)
 
virtual ~ON_Surface ()
 
ON_BrepBrepForm (ON_Brep *brep=nullptr) const override
 Overrides virtual ON_Geometry::HasBrepForm. Uses ON_Brep::Create( ON_Surface&* ) to create a brep form. The surface is copied for use in the returned brep. More...
 
void DestroySurfaceTree ()
 
bool Ev1Der (double u, double v, ON_3dPoint &point, ON_3dVector &du, ON_3dVector &dv, int quadrant=0, int *hint=0) const
 
bool Ev2Der (double u, double v, ON_3dPoint &point, ON_3dVector &du, ON_3dVector &dv, ON_3dVector &duu, ON_3dVector &duv, ON_3dVector &dvv, int quadrant=0, int *hint=0) const
 
bool EvaluatePoint (const class ON_ObjRef &objref, ON_3dPoint &P) const override
 virtual ON_Geometry override More...
 
bool EvNormal (double u, double v, ON_3dPoint &point, ON_3dVector &normal, int quadrant=0, int *hint=0) const
 
bool EvNormal (double u, double v, ON_3dVector &normal, int quadrant=0, int *hint=0) const
 
bool EvNormal (double u, double v, ON_3dPoint &point, ON_3dVector &du, ON_3dVector &dv, ON_3dVector &normal, int=0, int *=0) const
 
bool EvPoint (double u, double v, ON_3dPoint &point, int quadrant=0, int *hint=0) const
 
virtual bool Extend (int dir, const ON_Interval &domain)
 Pure virtual function. Default returns false. Where possible, analytically extends surface to include domain. More...
 
bool FrameAt (double u, double v, ON_Plane &frame) const
 
bool GetDomain (int dir, double *t0, double *t1) const
 surface interface More...
 
virtual bool GetSpanVectorIndex (int dir, double t, int side, int *span_vector_index, ON_Interval *span_interval) const
 
bool HasBrepForm () const override
 Overrides virtual ON_Geometry::HasBrepForm and returns true. Result: Returns true. More...
 
int IsAtSeam (double s, double t) const
 Test if a surface parameter value is at a seam. More...
 
bool IsAtSingularity (double s, double t, bool bExact=true) const
 Test if a surface parameter value is at a singularity. More...
 
bool IsCone (ON_Cone *cone=nullptr, double tolerance=ON_ZERO_TOLERANCE) const
 Determine if the surface is a portion of a cone. More...
 
bool IsCylinder (ON_Cylinder *cylinder=nullptr, double tolerance=ON_ZERO_TOLERANCE) const
 Determine if the surface is a portion of a cylinder. More...
 
bool IsSolid () const
 
bool IsSphere (ON_Sphere *sphere=nullptr, double tolerance=ON_ZERO_TOLERANCE) const
 Determine if the surface is a portion of a sphere. More...
 
bool IsTorus (ON_Torus *torus=nullptr, double tolerance=ON_ZERO_TOLERANCE) const
 Determine if the surface is a portion of a torus. More...
 
ON_3dVector NormalAt (double, double) const
 
ON_NurbsSurfaceNurbsSurface (ON_NurbsSurface *pNurbsSurface=nullptr, double tolerance=0.0, const ON_Interval *s_subdomain=nullptr, const ON_Interval *t_subdomain=nullptr) const
 Get a NURBS surface representation of this surface. More...
 
ON::object_type ObjectType () const override
 override ON_Object::ObjectType() - returns ON::surface_object More...
 
ON_Surfaceoperator= (const ON_Surface &)
 
ON_3dPoint PointAt (double, double) const
 simple evaluation interface - no error handling More...
 
bool SetDomain (int dir, ON_Interval domain)
 
virtual bool SetDomain (int dir, double t0, double t1)
 
virtual bool Split (int dir, double c, ON_Surface *&west_or_south_side, ON_Surface *&east_or_north_side) const
 Splits (divides) the surface into two parts at the specified parameter. More...
 
virtual bool Trim (int dir, const ON_Interval &domain)
 Removes the portions of the surface outside of the specified interval. More...
 
- Public Member Functions inherited from ON_Geometry
 ON_Geometry ()=default
 
 ON_Geometry (const ON_Geometry &)=default
 
 ~ON_Geometry ()=default
 
ON_BoundingBox BoundingBox () const
 Get object's 3d axis aligned bounding box. More...
 
virtual void ClearBoundingBox ()
 Some objects cache bounding box information. If you modify an object, then call ClearBoundingBox() to inform the object that any cached bounding boxes are invalid. More...
 
virtual ON_COMPONENT_INDEX ComponentIndex () const
 If this piece of geometry is a component in something larger, like an ON_BrepEdge in an ON_Brep, then this function returns the component index. More...
 
bool GetBoundingBox (ON_BoundingBox &bbox, bool bGrowBox=false) const
 Get object's 3d axis aligned bounding box or the union of the input box with the object's bounding box. More...
 
bool GetBoundingBox (ON_3dPoint &bbox_min, ON_3dPoint &bbox_max, bool bGrowBox=false) const
 Get corners of object's 3d axis aligned bounding box or the union of the input box with the object's bounding box. More...
 
virtual bool GetTightBoundingBox (class ON_BoundingBox &tight_bbox, bool bGrowBox=false, const class ON_Xform *xform=nullptr) const
 Get tight bounding box. More...
 
virtual bool IsDeformable () const
 
virtual bool MakeDeformable ()
 If possible, converts the object into a form that can be accuratly modified with "squishy" transformations like projections, shears, an non-uniform scaling. More...
 
ON_Geometryoperator= (const ON_Geometry &)=default
 
bool Rotate (double sin_angle, double cos_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
 Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule). More...
 
bool Rotate (double rotation_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
 Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule). More...
 
bool Scale (double scale_factor)
 Scales the object by the specified facotor. The scale is centered at the origin. More...
 
virtual bool SwapCoordinates (int i, int j)
 Swaps object coordinate values with indices i and j. More...
 
bool Translate (const ON_3dVector &translation_vector)
 Translates the object along the specified vector. 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 bool DeleteComponents (const ON_COMPONENT_INDEX *ci_list, size_t ci_count)
 Delete the portions of the object identified in ci_list[]. 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 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...
 
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...
 
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
 

Additional Inherited Members

- Public Types inherited from ON_Surface
enum  ISO {
  not_iso = 0, x_iso = 1, y_iso = 2, W_iso = 3,
  S_iso = 4, E_iso = 5, N_iso = 6, iso_count = 7
}
 pure virtual class for surface objects More...
 
- 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...
 
- Static Public Attributes inherited from ON_Geometry
static const ON_Geometry Unset
 

Constructor & Destructor Documentation

◆ ON_OffsetSurface() [1/2]

ON_OffsetSurface::ON_OffsetSurface ( )

◆ ~ON_OffsetSurface()

ON_OffsetSurface::~ON_OffsetSurface ( )

◆ ON_OffsetSurface() [2/2]

ON_OffsetSurface::ON_OffsetSurface ( const ON_OffsetSurface src)

Member Function Documentation

◆ BaseSurface()

const ON_Surface* ON_OffsetSurface::BaseSurface ( ) const
Returns
Base surface;

◆ Evaluate()

bool ON_OffsetSurface::Evaluate ( double  u,
double  v,
int  num_der,
int  array_stride,
double *  der_array,
int  quadrant = 0,
int *  hint = 0 
) const
overridevirtual

work horse evaluator

Implements ON_Surface.

◆ GetBBox()

bool ON_OffsetSurface::GetBBox ( double *  boxmin,
double *  boxmax,
bool  bGrowBox = false 
) const
overridevirtual

virtual ON_Geometry GetBBox override

Reimplemented from ON_Geometry.

◆ OffsetFunction() [1/2]

ON_OffsetSurfaceFunction& ON_OffsetSurface::OffsetFunction ( )

◆ OffsetFunction() [2/2]

const ON_OffsetSurfaceFunction& ON_OffsetSurface::OffsetFunction ( ) const

◆ operator=()

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

◆ SetBaseSurface() [1/2]

bool ON_OffsetSurface::SetBaseSurface ( const ON_Surface base_surface)

Sets base surface to a surface that is not managed by the ON_OffsetSurface class.

Parameters
base_surface[in] points to a base surface the caller insures will exist for the lifetimes of the ON_OffsetSurface class.
Returns
True if successful.

◆ SetBaseSurface() [2/2]

bool ON_OffsetSurface::SetBaseSurface ( ON_Surface base_surface,
bool  bManage 
)

Sets base surface to a surface that is optionally managed by the ON_OffsetSurface class.

Parameters
base_surface[in] points to a base surface the caller insures will exist for the lifetimes of the ON_OffsetSurface class.
bManage[in] if true, the base_surface must point to a surface that is on the heap and the surface will be deleted by ~ON_OffsetSurface.
Returns
True if successful.