DG Kernel Documentation


Skip Navigation Links.
Start page
Quick Start
Search Page
Installation
Overview of the software
What is new
Licensing
Expand ModelsModels
Expand DG Kernel ComponentsDG Kernel Components
Expand API ReferenceAPI Reference
Expand Samples and TutorialsSamples and Tutorials
Expand GraphicsGraphics
Expand Math ObjectsMath Objects
Collapse DeprecatedDeprecated
Redistribution
Model Viewer
Open Source
Support
Skip Navigation LinksHome Page > Deprecated > Deprecated API Reference > Model > Section > IPipeSection Search Documentation


IPipeSection Interface

GetCentralCurve(Get)
SetCentralCurve
GetDiameter
SetDiameter
GetInnerDiameter
SetInnerDiameter
GetInternalSurfaceFlag
SetInternalSurfaceFlag
GetRenderType
SetRenderType

IPipeSection interface is implemented by Pipe objects. IPipeSection interface can be queried from IUnknown returned from a call to Create or Create2 of IDIObjectGenerator interface with parameter eType set to eObjTypePipeEntity member of EObjectType enumeration.

See also: Pipes sample, Interface List


HRESULT GetCentralCurve(ICurve **curve)

Parameters

curve- [out, retval] The returned ICurve interface implemented by the central curve of the pipe.

Remarks:

Returns the current central curve of the pipe.


HRESULT SetCentralCurve(ICurve *curve)

Parameters

curve - [in] reference to externally created curve to be attached as central curve of the pipe

Remarks:

This property must be set to a valid curve before using the pipe in a model. The curve can be created with a call to Create(2) of IDIObjectGenerator interface with parameter eType set to eObjTypeFreeFormCurve or eObjTypeArcSplineCurve member of EObjectType enumeration.


HRESULT GetDiameter( double* diameter )

Parameters

diameter - [out, retval] The returned outer diameter of the pipe

Remarks:

Returns outer diameter of the pipe


HRESULT SetDiameter( double diameter )

Parameters

diameter - [in] The new value of outer diameter of the pipe

Remarks:

Sets outer diameter of the pipe


HRESULT GetInnerDiameter( double* diam )

Parameters

diam - [out, retval] The returned inner diameter of the pipe.

Remarks:

Returns inner diameter of the pipe.


HRESULT SetInnerDiameter( double diam )

Parameters

diam - [out, retval] The returned inner diameter of the pipe.

Remarks:

Modifies inner diameter of the pipe.


HRESULT GetInternalSurfaceFlag( VARIANT_BOOL* internSurf )

Parameters

internSurf - [out, retval] current value of InternalSurface property

Remarks:

Returns current value of the InternalSurface property


HRESULT SetInternalSurfaceFlag( VARIANT_BOOL internSurf )

Parameters

internSurf - [in] New value of the property

Remarks:

Modifies the InternalSurface property. Use also IBoundary interface queried from IPipeSection to add end patches to the entity and thus render the pipe a solid object.


HRESULT GetRenderType( int* type )

Parameters

type - [out] The current render type

Remarks:

Returns RenderType property of pipe entity. If 0 (default) rendering is performed using meshed surface. Direct drawing otherwise. See remarks for SetRenderType method


HRESULT SetRenderType( int type )

Parameters

type - [in] New value of RenderType property.

Remarks:

Modifies RenderType property of pipe entity. If 0 (default) meshed surface will be created to improve performance of rendering. If this property is set to any other value the object will be rendered without using mesh, thus reducing memory consumption.